sjyang18 commented on a change in pull request #3817: NIFI-6583: adding azure log analytics reporting task to nifi-azure-bu… URL: https://github.com/apache/nifi/pull/3817#discussion_r337847436
########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-reporting-task/src/main/java/org/apache/nifi/reporting/azure/loganalytics/AzureLogAnalyticsReportingTask.java ########## @@ -0,0 +1,335 @@ +/* + * 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.nifi.reporting.azure.loganalytics; + +import java.io.IOException; +import java.nio.charset.Charset; +import java.security.InvalidKeyException; +import java.security.NoSuchAlgorithmException; +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.List; +import java.util.regex.Pattern; + +import javax.crypto.Mac; +import javax.crypto.spec.SecretKeySpec; +import javax.xml.bind.DatatypeConverter; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; + +import org.apache.http.client.methods.CloseableHttpResponse; +import org.apache.http.client.methods.HttpPost; +import org.apache.http.entity.StringEntity; +import org.apache.http.impl.client.CloseableHttpClient; +import org.apache.http.impl.client.HttpClients; +import org.apache.nifi.annotation.configuration.DefaultSchedule; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.controller.status.ConnectionStatus; +import org.apache.nifi.controller.status.ProcessGroupStatus; +import org.apache.nifi.controller.status.ProcessorStatus; +import org.apache.nifi.expression.ExpressionLanguageScope; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.reporting.AbstractReportingTask; +import org.apache.nifi.reporting.ReportingContext; +import org.apache.nifi.reporting.azure.loganalytics.api.AzureLogAnalyticsMetricsFactory; +import org.apache.nifi.scheduling.SchedulingStrategy; +import org.apache.nifi.annotation.lifecycle.OnScheduled; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.metrics.jvm.JmxJvmMetrics; +import org.apache.nifi.metrics.jvm.JvmMetrics; +import java.time.ZoneOffset; +import java.time.ZonedDateTime; +import java.time.format.DateTimeFormatter; + + +/** + * ReportingTask to send metrics from Apache NiFi and JVM to Azure Monitor. + */ +@Tags({"reporting", "loganalytics", "metrics"}) +@CapabilityDescription("Sends JVM-metrics as well as Apache NiFi-metrics to a Azure Log Analytics workspace." + + "Apache NiFi-metrics can be either configured global or on process-group level.") +@DefaultSchedule(strategy = SchedulingStrategy.TIMER_DRIVEN, period = "1 min") +public class AzureLogAnalyticsReportingTask extends AbstractReportingTask { + + private static final String JVM_JOB_NAME = "jvm_global"; + private static final Charset UTF8 = Charset.forName("UTF-8"); + private static final String HMAC_SHA256_ALG = "HmacSHA256"; + static final DateTimeFormatter RFC_1123_DATE_TIME = DateTimeFormatter.ofPattern("EEE, dd MMM yyyy HH:mm:ss O"); + private volatile JvmMetrics virtualMachineMetrics; + + + static final PropertyDescriptor LOG_ANALYTICS_WORKSPACE_ID = new PropertyDescriptor.Builder() + .name("Log Analytics Workspace Id") + .description("Log Analytics Workspace Id") + .required(true) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .sensitive(true) + .build(); + static final PropertyDescriptor LOG_ANALYTICS_CUSTOM_LOG_NAME = new PropertyDescriptor.Builder() + .name("Log Analytics Custom Log Name") + .description("Log Analytics Custom Log Name") + .required(false) + .defaultValue("nifimetrics") + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .build(); + static final PropertyDescriptor LINUX_PRIMARY_KEY = new PropertyDescriptor.Builder() + .name("Linux Primary Key") + .description("Connected Sources - Linux Primary Key") + .required(true) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .sensitive(true) + .build(); + static final PropertyDescriptor APPLICATION_ID = new PropertyDescriptor.Builder() + .name("Application ID") + .description("The Application ID to be included in the metrics sent to Azure Log Analytics WS") + .required(true) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .defaultValue("nifi") + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + static final PropertyDescriptor INSTANCE_ID = new PropertyDescriptor.Builder() + .name("Instance ID") + .description("Id of this NiFi instance to be included in the metrics sent to Azure Log Analytics WS") + .required(true) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .defaultValue("${hostname(true)}") + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + static final PropertyDescriptor PROCESS_GROUP_IDS = new PropertyDescriptor.Builder() + .name("Process group ID(s)") + .description("If specified, the reporting task will send metrics the configured ProcessGroup(s) only. Multiple IDs should be separated by a comma. If" + + " none of the group-IDs could be found or no IDs are defined, the NiFi-Flow-ProcessGroup is used and global metrics are sent.") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .addValidator(StandardValidators + .createListValidator(true, true, StandardValidators.createRegexMatchingValidator(Pattern.compile("[0-9a-z-]+")))) + .build(); + static final PropertyDescriptor JOB_NAME = new PropertyDescriptor.Builder() + .name("The job name") + .description("The name of the exporting job") + .defaultValue("nifi_reporting_job") + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + static final PropertyDescriptor SEND_JVM_METRICS = new PropertyDescriptor.Builder() + .name("Send JVM-metrics") + .description("Send JVM-metrics in addition to the NiFi-metrics") + .allowableValues("true", "false") + .defaultValue("false") + .required(true) + .build(); + static final PropertyDescriptor LOG_ANALYTICS_URL_ENDPOINT_FORMAT = new PropertyDescriptor.Builder() + .name("Log Analytics URL Endpoint Format") + .description("Log Analytics URL Endpoint Format") + .required(false) + .defaultValue("https://{0}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01";) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .build(); + + private String createAuthorization(String workspaceId, String key, int contentLength, String rfc1123Date) { + try { + // Documentation: https://docs.microsoft.com/en-us/rest/api/loganalytics/create-request + String signature = String.format("POST\n%d\napplication/json\nx-ms-date:%s\n/api/logs", contentLength, rfc1123Date); + Mac mac = Mac.getInstance(HMAC_SHA256_ALG); + mac.init(new SecretKeySpec(DatatypeConverter.parseBase64Binary(key), HMAC_SHA256_ALG)); + String hmac = DatatypeConverter.printBase64Binary(mac.doFinal(signature.getBytes(UTF8))); + return String.format("SharedKey %s:%s", workspaceId, hmac); + } catch (NoSuchAlgorithmException | InvalidKeyException e) { + throw new RuntimeException(e); + } + } + + @OnScheduled + public void setup(final ConfigurationContext context) { + virtualMachineMetrics = JmxJvmMetrics.getInstance(); + } + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + final List<PropertyDescriptor> properties = new ArrayList<>(); + properties.add(LOG_ANALYTICS_WORKSPACE_ID); + properties.add(LOG_ANALYTICS_CUSTOM_LOG_NAME); + properties.add(LINUX_PRIMARY_KEY); + properties.add(APPLICATION_ID); + properties.add(INSTANCE_ID); + properties.add(PROCESS_GROUP_IDS); + properties.add(JOB_NAME); + properties.add(SEND_JVM_METRICS); + properties.add(LOG_ANALYTICS_URL_ENDPOINT_FORMAT); + return properties; + } + + @Override + public void onTrigger(final ReportingContext context){ + final String workspaceId = context.getProperty(LOG_ANALYTICS_WORKSPACE_ID).evaluateAttributeExpressions().getValue(); + final String linuxPrimaryKey = context.getProperty(LINUX_PRIMARY_KEY).evaluateAttributeExpressions().getValue(); + final boolean jvmMetricsCollected = context.getProperty(SEND_JVM_METRICS).asBoolean(); + + final String logName = context.getProperty(LOG_ANALYTICS_CUSTOM_LOG_NAME).evaluateAttributeExpressions().getValue(); + final String instanceId = context.getProperty(INSTANCE_ID).evaluateAttributeExpressions().getValue(); + final String groupIds = context.getProperty(PROCESS_GROUP_IDS).evaluateAttributeExpressions().getValue(); + final String urlEndpointFormat = context.getProperty(LOG_ANALYTICS_URL_ENDPOINT_FORMAT).evaluateAttributeExpressions().getValue(); + try { + List<Metric> allMetrics = null; + if(groupIds == null || groupIds.isEmpty()) { + ProcessGroupStatus status = context.getEventAccess().getControllerStatus(); + String processGroupName = status.getName(); + allMetrics = collectMetrics(instanceId, status, processGroupName, jvmMetricsCollected); + } else { + allMetrics = new ArrayList<>(); + for(String groupId: groupIds.split(",")) { + groupId =groupId.trim(); + ProcessGroupStatus status = context.getEventAccess().getGroupStatus(groupId); + String processGroupName = status.getName(); + allMetrics.addAll(collectMetrics(instanceId, status, processGroupName, jvmMetricsCollected)); + } + } + HttpPost httpPost = getHttpPost(urlEndpointFormat, workspaceId, logName); + sendMetrics(httpPost, workspaceId, linuxPrimaryKey, allMetrics); + } catch (IOException | RuntimeException e) { + getLogger().error("Exception in outmost block", e); + } + } + + /** + * Construct HttpPost and return it + * @param urlFormat URL format to Azure Log Analytics Endpoint + * @param workspaceId your azure log analytics workspace id + * @param logName log table name where metrics will be pushed + * @return HttpsURLConnection to your azure log analytics workspace + * @throws IllegalArgumentException if dataCollectorEndpoint url is invalid + */ + protected HttpPost getHttpPost(final String urlFormat, final String workspaceId, final String logName) + throws IllegalArgumentException { + String dataCollectorEndpoint = + MessageFormat.format(urlFormat, workspaceId); + HttpPost post = new HttpPost(dataCollectorEndpoint); + post.addHeader("Content-Type", "application/json"); + post.addHeader("Log-Type", logName); + return post; + } + /** + * send collected metrics to azure log analytics workspace + * @param request HttpPost to Azure Log Analytics Endpoint + * @param workspaceId your azure log analytics workspace id + * @param linuxPrimaryKey your azure log analytics workspace key + * @param allMetrics collected metrics to be sent + * @throws IOException when there is an error in https url connection or read/write to the onnection + * @throws IllegalArgumentException when there a exception in converting metrics to json string with Gson.toJson + * @throws RuntimeException when httpPost fails with none 200 status code + */ + protected void sendMetrics(final HttpPost request, final String workspaceId, final String linuxPrimaryKey, final List<Metric> allMetrics) + throws IOException, IllegalArgumentException, RuntimeException { + + Gson gson = new GsonBuilder().create(); + StringBuilder builder = new StringBuilder(); + builder.append('['); + for (Metric current : allMetrics) { + builder.append(gson.toJson(current)); + builder.append(','); + } + builder.append(']'); + + final String rawJson = builder.toString(); + final int bodyLength = rawJson.getBytes(UTF8).length; + final String nowRfc1123 = RFC_1123_DATE_TIME.format(ZonedDateTime.now(ZoneOffset.UTC)); + final String createAuthorization = createAuthorization(workspaceId, linuxPrimaryKey, bodyLength, nowRfc1123); + request.addHeader("Authorization", createAuthorization); + request.addHeader("x-ms-date", nowRfc1123); + request.setEntity(new StringEntity(builder.toString())); Review comment: fixed as recommended ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
