Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Ballerina metrics logs observer #43615

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import io.ballerina.runtime.api.Environment;
import io.ballerina.runtime.api.Module;
import io.ballerina.runtime.api.Runtime;
import io.ballerina.runtime.api.types.ObjectType;
import io.ballerina.runtime.api.types.PredefinedTypes;
import io.ballerina.runtime.api.utils.StringUtils;
Expand Down Expand Up @@ -72,6 +73,8 @@ public final class ObserveUtils {
private static final BString metricsReporter;
private static final boolean tracingEnabled;
private static final BString tracingProvider;
private static final boolean metricsLogsEnabled;
private static final BString metricsLogsProvider;

static {
// TODO: Move config initialization to ballerina level once checking config key is possible at ballerina level
Expand All @@ -88,13 +91,19 @@ public final class ObserveUtils {
, false);
VariableKey tracingProviderKey = new VariableKey(observeModule, "tracingProvider",
PredefinedTypes.TYPE_STRING, false);
VariableKey metricsLogsEnabledKey = new VariableKey(observeModule, "metricsLogsEnabled", PredefinedTypes.TYPE_BOOLEAN
, false);
VariableKey metricsLogsProviderKey = new VariableKey(observeModule, "metricsLogsProvider",
PredefinedTypes.TYPE_STRING, false);

metricsEnabled = readConfig(metricsEnabledKey, enabledKey, false);
metricsProvider = readConfig(metricsProviderKey, null, StringUtils.fromString("default"));
metricsReporter = readConfig(metricsReporterKey, providerKey, StringUtils.fromString("choreo"));
tracingEnabled = readConfig(tracingEnabledKey, enabledKey, false);
tracingProvider = readConfig(tracingProviderKey, providerKey, StringUtils.fromString("choreo"));
enabled = metricsEnabled || tracingEnabled;
metricsLogsEnabled = readConfig(metricsLogsEnabledKey, enabledKey, false);
metricsLogsProvider = readConfig(metricsLogsProviderKey, providerKey, StringUtils.fromString("choreo"));
enabled = metricsEnabled || tracingEnabled || metricsLogsEnabled;
}

private ObserveUtils() {
Expand Down Expand Up @@ -136,6 +145,14 @@ public static BString getTracingProvider() {
return tracingProvider;
}

public static boolean isMetricsLogsEnabled() {
return metricsLogsEnabled;
}

public static BString getMetricsLogsProvider() {
return metricsLogsProvider;
}

/**
* Add metrics and tracing observers.
*
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
package io.ballerina.runtime.observability.metrics;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

License text missing


import io.ballerina.runtime.api.Environment;
import io.ballerina.runtime.api.Module;
import io.ballerina.runtime.api.creators.ValueCreator;
import io.ballerina.runtime.api.utils.StringUtils;
import io.ballerina.runtime.api.values.BMap;
import io.ballerina.runtime.api.values.BString;
import io.ballerina.runtime.observability.BallerinaObserver;
import io.ballerina.runtime.observability.ObserveUtils;
import io.ballerina.runtime.observability.ObserverContext;

import java.io.PrintStream;
import java.util.HashSet;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

import static io.ballerina.runtime.observability.ObservabilityConstants.*;

NipunaMadhushan marked this conversation as resolved.
Show resolved Hide resolved
public class BallerinaMetricsLogsObserver implements BallerinaObserver {
NipunaMadhushan marked this conversation as resolved.
Show resolved Hide resolved
private static final String ORG_NAME = "ballerinax";
private static final String PROPERTY_START_TIME = "_observation_start_time_";
private static final PrintStream consoleError = System.err;

private static Environment environment;

public BallerinaMetricsLogsObserver(Environment environment) {
BallerinaMetricsLogsObserver.environment = environment;
}

@Override
public void startServerObservation(ObserverContext observerContext) {
}

@Override
public void startClientObservation(ObserverContext observerContext) {
}

@Override
public void stopServerObservation(ObserverContext observerContext) {
if (!observerContext.isStarted()) {
// Do not collect metrics if the observation hasn't started
return;
}
stopObservation(observerContext);
}

@Override
public void stopClientObservation(ObserverContext observerContext) {
if (!observerContext.isStarted()) {
// Do not collect metrics if the observation hasn't started
return;
}
stopObservation(observerContext);
}

private void stopObservation(ObserverContext observerContext) {
Set<Tag> tags = new HashSet<>();
Map<String, Tag> customTags = observerContext.customMetricTags;
if (customTags != null) {
tags.addAll(customTags.values());
}
tags.addAll(observerContext.getAllTags());

// Add status_code_group tag
Integer statusCode = (Integer) observerContext.getProperty(PROPERTY_KEY_HTTP_STATUS_CODE);
if (statusCode != null && statusCode > 0) {
tags.add(Tag.of(TAG_KEY_HTTP_STATUS_CODE_GROUP, (statusCode / 100) + STATUS_CODE_GROUP_SUFFIX));
}

try {
Long startTime = (Long) observerContext.getProperty(PROPERTY_START_TIME);
long duration = System.nanoTime() - startTime;

Optional<String> protocolValue = Optional.empty();
if (tags.stream().anyMatch(tag -> tag.getKey().equals("protocol"))) {
protocolValue = tags.stream().filter(tag -> tag.getKey().equals("protocol")).map(Tag::getValue).findFirst();
}
String protocol = protocolValue.orElse("http");

BMap<BString, Object> logAttributes = ValueCreator.createMapValue();
logAttributes.put(StringUtils.fromString("protocol"), StringUtils.fromString(protocol));
tags.stream().filter(tag -> !tag.getKey().equals("protocol"))
.forEach(tag -> logAttributes.put(StringUtils.fromString(tag.getKey()),
StringUtils.fromString(tag.getValue())));
logAttributes.put(StringUtils.fromString("response_time_seconds"),
StringUtils.fromString(String.valueOf(duration / 1E9)));

printMetricLog(logAttributes);
} catch (RuntimeException e) {
handleError("multiple metrics", tags, e);
}
}

private void handleError(String metricName, Set<Tag> tags, RuntimeException e) {
// Metric Provider may throw exceptions if there is a mismatch in tags.
consoleError.println("error: error collecting metrics for " + metricName + " with tags " + tags +
": " + e.getMessage());
}

private static void printMetricLog(BMap<BString, Object> logAttributes) {
// TODO: Remove version when the API is finalized, and add the configured org name.
Module metricsLogsModule = new Module(ORG_NAME, ObserveUtils.getMetricsLogsProvider().getValue(), "1");
environment.getRuntime().callFunction(metricsLogsModule, "printMetricsLog", null, logAttributes);
}
}
Loading