feat: wire EMF file output into NucleusEmitter publish flow #22
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,19 +9,23 @@ | |
| import com.aws.greengrass.config.Topics; | ||
| import com.aws.greengrass.dependency.ImplementsService; | ||
| import com.aws.greengrass.dependency.State; | ||
| import com.aws.greengrass.deployment.DeviceConfiguration; | ||
| import com.aws.greengrass.lifecyclemanager.PluginService; | ||
| import com.aws.greengrass.telemetry.impl.Metric; | ||
| import com.aws.greengrass.telemetry.nucleus.emitter.emf.EmfFileWriter; | ||
| import com.aws.greengrass.telemetry.nucleus.emitter.metrics.KernelMetricsEmitter; | ||
| import com.aws.greengrass.telemetry.nucleus.emitter.metrics.SystemMetricsEmitter; | ||
| import com.aws.greengrass.telemetry.nucleus.emitter.publisher.MqttPublisher; | ||
| import com.aws.greengrass.telemetry.nucleus.emitter.publisher.PubSubPublisher; | ||
| import com.aws.greengrass.util.Coerce; | ||
| import com.aws.greengrass.util.SerializerFactory; | ||
| import com.aws.greengrass.util.Utils; | ||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import lombok.AccessLevel; | ||
| import lombok.Getter; | ||
|
|
||
| import java.nio.file.Paths; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
|
|
@@ -64,6 +68,8 @@ public class NucleusEmitter extends PluginService { | |
| //Metric publishers | ||
| private final PubSubPublisher pubSubPublisher; | ||
| private final MqttPublisher mqttPublisher; | ||
| // volatile ensures visibility across config subscriber and publish threads | ||
| private volatile EmfFileWriter emfFileWriter; | ||
|
|
||
| private final ChildChanged subscribeToConfigChanges = (what, topic) -> | ||
| handleConfiguration(this.config.lookupTopics(CONFIGURATION_CONFIG_KEY)); | ||
|
|
@@ -108,9 +114,14 @@ private void handleConfiguration(Topics configurationTopics) { | |
| .equals(newConfiguration.getExcludeMounts()); | ||
| boolean excludeInterfacesChanged = !configuration.getExcludeInterfaces() | ||
| .equals(newConfiguration.getExcludeInterfaces()); | ||
| boolean outputModeChanged = !configuration.getOutputMode() | ||
| .equals(newConfiguration.getOutputMode()); | ||
| boolean outputDirectoryChanged = !configuration.getOutputDirectory() | ||
| .equals(newConfiguration.getOutputDirectory()); | ||
|
|
||
| if (!pubSubPublishChanged && !mqttTopicChanged && !telemetryPublishIntervalMsChanged | ||
| && !metricsLevelChanged && !excludeMountsChanged && !excludeInterfacesChanged | ||
| && !outputModeChanged && !outputDirectoryChanged) { | ||
| return; | ||
| } | ||
|
|
||
|
|
@@ -138,6 +149,14 @@ private void handleConfiguration(Topics configurationTopics) { | |
| newConfiguration.getExcludeMounts(), | ||
| newConfiguration.getExcludeInterfaces()); | ||
| } | ||
| if (outputModeChanged || outputDirectoryChanged) { | ||
| if (newConfiguration.isEmfEnabled()) { | ||
| this.emfFileWriter = new EmfFileWriter(getThingName(), | ||
| Paths.get(newConfiguration.getOutputDirectory())); | ||
|
Member
There was a problem hiding this comment. Recommendation generated by Amazon CodeGuru Reviewer. Leave feedback on this recommendation by replying to the comment or by reacting to the comment using emoji. Path traversal vulnerability detected. User-controlled input in file paths |
||
| } else { | ||
| this.emfFileWriter = null; // NOPMD NullAssignment - disables EMF output | ||
| } | ||
| } | ||
| scheduleTelemetryPublish(); | ||
| } | ||
|
|
||
|
|
@@ -151,16 +170,36 @@ public void startup() { | |
| scheduleTelemetryPublish(); | ||
| } | ||
|
|
||
| private void publishTelemetry(boolean pubSubPublish, String pubSubTopic, | ||
| boolean mqttPublish, String mqttTopic) { | ||
| List<Metric> metrics = collectMetrics(); | ||
| if (pubSubPublish || mqttPublish) { | ||
| String jsonString = null; // NOPMD - set in try, checked before use | ||
| try { | ||
| jsonString = jsonMapper.writeValueAsString(metrics); | ||
| } catch (JsonProcessingException e) { | ||
| logger.error(JSON_PARSE_ERROR_LOG, e); | ||
| } | ||
| if (pubSubPublish && jsonString != null) { | ||
| this.pubSubPublisher.publishMessage(jsonString, pubSubTopic); | ||
| } | ||
| if (mqttPublish && jsonString != null) { | ||
| this.mqttPublisher.publishMessage(jsonString, mqttTopic); | ||
| } | ||
| } | ||
| EmfFileWriter localEmf = this.emfFileWriter; | ||
| if (localEmf != null) { | ||
| localEmf.write(metrics); | ||
| } | ||
| } | ||
|
|
||
| private List<Metric> collectMetrics() { | ||
| SystemMetricsEmitter localSme = this.sme; | ||
| return Stream.of(localSme.getMetrics(), kme.getMetrics()) | ||
| .flatMap(Collection::stream) | ||
| .collect(Collectors.toList()); | ||
| } | ||
|
|
||
| private void scheduleTelemetryPublish() { | ||
| final NucleusEmitterConfiguration configuration = currentConfiguration.get(); | ||
| final boolean newPubPublish = configuration.isPubsubPublish(); | ||
|
|
@@ -192,13 +231,9 @@ private void scheduleTelemetryPublish() { | |
| } | ||
|
|
||
| protected String retrieveMetricsJson(ObjectMapper jsonMapper) { | ||
| String jsonString = null; | ||
| try { | ||
| List<Metric> metrics = collectMetrics(); | ||
| jsonString = jsonMapper.writeValueAsString(metrics); | ||
| } catch (JsonProcessingException e) { | ||
| logger.error(JSON_PARSE_ERROR_LOG, e); | ||
|
|
@@ -209,6 +244,13 @@ protected String retrieveMetricsJson(ObjectMapper jsonMapper) { | |
| @Override | ||
| public void shutdown() { | ||
| cancelJob(telemetryPublishFuture, telemetryPublishInProgressLock, true); | ||
| this.emfFileWriter = null; // NOPMD NullAssignment - release on shutdown | ||
| } | ||
|
|
||
| private String getThingName() { | ||
| return Coerce.toString( | ||
| this.context.get(DeviceConfiguration.class) | ||
| .getThingName()); | ||
| } | ||
|
|
||
| private void cancelJob(ScheduledFuture<?> future, Object lock, boolean immediately) { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package com.aws.greengrass.telemetry.nucleus.emitter.emf; | ||
|
|
||
| import com.aws.greengrass.logging.api.Logger; | ||
| import com.aws.greengrass.logging.impl.LogManager; | ||
| import com.aws.greengrass.telemetry.impl.Metric; | ||
| import com.aws.greengrass.telemetry.models.TelemetryUnit; | ||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||
| import software.amazon.cloudwatchlogs.emf.model.DimensionSet; | ||
| import software.amazon.cloudwatchlogs.emf.model.MetricsContext; | ||
| import software.amazon.cloudwatchlogs.emf.model.Unit; | ||
|
|
||
| import java.nio.file.Path; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.LinkedHashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Serializes metrics in EMF (Embedded Metric Format) and writes them via a | ||
| * raw Greengrass logger (no envelope). The GG Log Manager handles file rotation | ||
| * and upload to CloudWatch Logs, where EMF is auto-parsed into CloudWatch Metrics. | ||
| */ | ||
| public class EmfFileWriter { | ||
|
|
||
| private static final Logger logger = LogManager.getLogger(EmfFileWriter.class); | ||
|
|
||
| private static final Map<TelemetryUnit, Unit> UNIT_MAP; | ||
|
|
||
| static { | ||
| Map<TelemetryUnit, Unit> m = new LinkedHashMap<>(); | ||
| m.put(TelemetryUnit.Percent, Unit.PERCENT); | ||
| m.put(TelemetryUnit.Bytes, Unit.BYTES); | ||
| m.put(TelemetryUnit.Megabytes, Unit.MEGABYTES); | ||
| m.put(TelemetryUnit.Count, Unit.COUNT); | ||
| UNIT_MAP = Collections.unmodifiableMap(m); | ||
| } | ||
|
|
||
| private final String thingName; | ||
| private final Logger emfLogger; | ||
|
|
||
| /** | ||
| * Creates an EmfFileWriter. | ||
| * | ||
| * @param thingName thing name for dimensions | ||
| * @param outputDirectory directory for EMF output files | ||
| */ | ||
| public EmfFileWriter(String thingName, Path outputDirectory) { | ||
| this.thingName = thingName; | ||
| this.emfLogger = LogManager.getRawLogger("emf-metrics", outputDirectory); | ||
| } | ||
|
|
||
| /** | ||
| * Serializes metrics to EMF JSON and writes them via the raw logger. | ||
| * | ||
| * @param metrics list of metrics to write | ||
| */ | ||
| public void write(List<Metric> metrics) { | ||
| if (metrics == null || metrics.isEmpty()) { | ||
| return; | ||
| } | ||
| Map<String, List<Metric>> byNamespace = groupByNamespace(metrics); | ||
| for (Map.Entry<String, List<Metric>> entry : byNamespace.entrySet()) { | ||
| MetricsContext context = new MetricsContext(); | ||
| context.setNamespace(entry.getKey()); | ||
| context.putDimension(DimensionSet.of("ThingName", thingName)); | ||
| for (Metric metric : entry.getValue()) { | ||
| if (!(metric.getValue() instanceof Number)) { | ||
| continue; | ||
| } | ||
| context.putMetric(metric.getName(), | ||
| ((Number) metric.getValue()).doubleValue(), | ||
| toEmfUnit(metric.getUnit())); | ||
| } | ||
| try { | ||
| for (String line : context.serialize()) { | ||
| emfLogger.atInfo().log(line); | ||
| } | ||
| } catch (JsonProcessingException e) { | ||
| logger.error("Failed to serialize EMF metrics", e); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private Map<String, List<Metric>> groupByNamespace(List<Metric> metrics) { | ||
| Map<String, List<Metric>> result = new LinkedHashMap<>(); | ||
| for (Metric m : metrics) { | ||
| result.computeIfAbsent(m.getNamespace(), k -> new ArrayList<>()).add(m); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| private static Unit toEmfUnit(TelemetryUnit unit) { | ||
| return UNIT_MAP.getOrDefault(unit, Unit.NONE); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will this tmp file get cleanup after the test?