gortiz commented on code in PR #15037: URL: https://github.com/apache/pinot/pull/15037#discussion_r1975584205
########## pinot-spi/src/main/java/org/apache/pinot/spi/exception/QueryErrorMessage.java: ########## @@ -0,0 +1,94 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.pinot.spi.exception; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.node.ObjectNode; +import javax.annotation.Nullable; +import org.apache.pinot.spi.utils.JsonUtils; + + +public class QueryErrorMessage { + /** + * Error code for the exception, usually obtained from {@link QueryException}. + */ + private final QueryErrorCode _errCode; + /** + * User facing error message. + * + * This message is intended to be shown to the user and should not contain implementation details (including stack + * traces or class names). + */ + private final String _usrMsg; + /** + * Log message for the exception. + * + * This message is intended to be logged and may contain implementation details (including stack traces or class + * names) but it must never contain any sensitive information (including user data). + */ + private final String _logMsg; + + @JsonCreator + public QueryErrorMessage( + @JsonProperty("e") QueryErrorCode errCode, + @JsonProperty("u") @Nullable String usrMsg, + @JsonProperty("l") @Nullable String logMsg) { Review Comment: > Why these single letter JSON property names? This is mainly to make the format more efficient. It is probably overengineering and not necessary at all, given that we don't usually send too many query error messages together and the messages themselves are pretty long. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
