mirror of
https://github.com/google/nomulus.git
synced 2025-05-01 12:37:52 +02:00
f2c6021db0
This prevents a possible failure mode of the logging where the logged EPP input XML is very large (which can happen e.g. for domain creates with large SMD values). In those cases, the XML might cause the overall JSON string to be too large to fit within a single log entry [1], in which case it gets split over multiple lines and breaks automatic parsing. This mitigates that case by logging the EPP input (raw and base64-encoded) in a separate log statement so that the more compact metadata (like clientId) and derived values (like ICANN reporting field) will still be in an intact JSON string even in that case, and can still be readily parsed. It's okay if the actual EPP XML is harder to parse, since once we're logging the right metadata fields we shouldn't need to automatically parse the EPP XML in any normal cases. [1] I haven't found this exact limit or splitting algorithm, or whether it's a property of java logging or GAE log ingestion. The GAE logs page does note that a single application log entry (within a request, which can have up to 1000 such entries) maxes out at 8KB, so that might be it: https://cloud.google.com/appengine/docs/standard/java/logs/#writing_application_logs ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=153771335
87 lines
3.5 KiB
Java
87 lines
3.5 KiB
Java
// Copyright 2017 The Nomulus Authors. All Rights Reserved.
|
|
//
|
|
// Licensed 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 google.registry.flows;
|
|
|
|
import static com.google.common.io.BaseEncoding.base64;
|
|
import static google.registry.xml.XmlTransformer.prettyPrint;
|
|
|
|
import com.google.common.collect.ImmutableMap;
|
|
import google.registry.flows.FlowModule.ClientId;
|
|
import google.registry.flows.FlowModule.InputXml;
|
|
import google.registry.flows.annotations.ReportingSpec;
|
|
import google.registry.model.eppcommon.Trid;
|
|
import google.registry.util.FormattingLogger;
|
|
import javax.inject.Inject;
|
|
import org.json.simple.JSONValue;
|
|
|
|
/** Reporter used by {@link FlowRunner} to record flow execution data for reporting. */
|
|
public class FlowReporter {
|
|
|
|
/**
|
|
* Log signature for recording flow EPP input data.
|
|
*
|
|
* <p><b>WARNING:<b/> DO NOT CHANGE this value unless you want to break reporting.
|
|
*/
|
|
private static final String EPPINPUT_LOG_SIGNATURE = "FLOW-LOG-SIGNATURE-EPPINPUT";
|
|
|
|
/**
|
|
* Log signature for recording flow metadata (anything beyond or derived from the raw EPP input).
|
|
*
|
|
* <p><b>WARNING:<b/> DO NOT CHANGE this value unless you want to break reporting.
|
|
*/
|
|
private static final String METADATA_LOG_SIGNATURE = "FLOW-LOG-SIGNATURE-METADATA";
|
|
|
|
private static final FormattingLogger logger = FormattingLogger.getLoggerForCallerClass();
|
|
|
|
@Inject Trid trid;
|
|
@Inject @ClientId String clientId;
|
|
@Inject @InputXml byte[] inputXmlBytes;
|
|
@Inject Class<? extends Flow> flowClass;
|
|
@Inject FlowReporter() {}
|
|
|
|
/** Records information about the current flow execution in the GAE request logs. */
|
|
public void recordToLogs() {
|
|
// WARNING: These log statements are parsed by reporting pipelines - be careful when changing.
|
|
// It should be safe to add new keys, but be very cautious in changing existing keys.
|
|
logger.infofmt(
|
|
"%s: %s",
|
|
EPPINPUT_LOG_SIGNATURE,
|
|
JSONValue.toJSONString(ImmutableMap.<String, Object>of(
|
|
"xml", prettyPrint(inputXmlBytes),
|
|
"xmlBytes", base64().encode(inputXmlBytes))));
|
|
// Explicitly log flow metadata separately from the EPP XML itself so that it stays compact
|
|
// enough to be sure to fit in a single log entry (the XML part in rare cases could be long
|
|
// enough to overflow into multiple log entries, breaking routine parsing of the JSON format).
|
|
logger.infofmt(
|
|
"%s: %s",
|
|
METADATA_LOG_SIGNATURE,
|
|
JSONValue.toJSONString(ImmutableMap.<String, Object>of(
|
|
"trid", trid.getServerTransactionId(),
|
|
"clientId", clientId,
|
|
"icannActivityReportField", extractActivityReportField(flowClass))));
|
|
}
|
|
|
|
/**
|
|
* Returns the ICANN activity report field for the given flow class, or the empty string if no
|
|
* activity report field specification is found.
|
|
*/
|
|
private static final String extractActivityReportField(Class<? extends Flow> flowClass) {
|
|
ReportingSpec reportingSpec = flowClass.getAnnotation(ReportingSpec.class);
|
|
if (reportingSpec != null) {
|
|
return reportingSpec.value().getFieldName();
|
|
}
|
|
return "";
|
|
}
|
|
}
|