Skip to content

Commit

Permalink
added draft example of a Java azure function
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitchsplunk committed Dec 5, 2024
1 parent 0811852 commit 8f09ac5
Show file tree
Hide file tree
Showing 11 changed files with 590 additions and 3 deletions.
4 changes: 2 additions & 2 deletions instrumentation/dotnet/azure-functions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ similar.

## Prerequisites

The following tools are required to deploy .NET functions into AWS Lambda:
The following tools are required to deploy .NET Azure functions:

* An Azure account with permissions to create and execute Azure functions
* [Visual Studio Code](https://code.visualstudio.com/)
Expand Down Expand Up @@ -210,7 +210,7 @@ Hello, World!

### View Traces in Splunk Observability Cloud

After a minute or so, you should start to see traces for the lambda function
After a minute or so, you should start to see traces for the serverless function
appearing in Splunk Observability Cloud:

![Trace](./images/trace.png)
Expand Down
38 changes: 38 additions & 0 deletions instrumentation/java/azure-functions/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Build output
target/
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.ear
*.zip
*.tar.gz
*.rar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*

# IDE
.idea/
*.iml
.settings/
.project
.classpath

# macOS
.DS_Store

# Azure Functions
local.settings.json
bin/
obj/
6 changes: 6 additions & 0 deletions instrumentation/java/azure-functions/.vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"recommendations": [
"ms-azuretools.vscode-azurefunctions",
"vscjava.vscode-java-debug"
]
}
13 changes: 13 additions & 0 deletions instrumentation/java/azure-functions/.vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Attach to Java Functions",
"type": "java",
"request": "attach",
"hostName": "127.0.0.1",
"port": 5005,
"preLaunchTask": "func: host start"
}
]
}
8 changes: 8 additions & 0 deletions instrumentation/java/azure-functions/.vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"azureFunctions.javaBuildTool": "maven",
"azureFunctions.deploySubpath": "target/azure-functions/azure_function_java_opentelemetry_example",
"azureFunctions.projectLanguage": "Java",
"azureFunctions.projectRuntime": "~4",
"debug.internalConsoleOptions": "neverOpen",
"azureFunctions.preDeployTask": "package (functions)"
}
25 changes: 25 additions & 0 deletions instrumentation/java/azure-functions/.vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"version": "2.0.0",
"tasks": [
{
"type": "func",
"label": "func: host start",
"command": "host start",
"problemMatcher": "$func-java-watch",
"isBackground": true,
"options": {
"cwd": "${workspaceFolder}/target/azure-functions/azure_function_java_opentelemetry_example"
},
"dependsOn": "package (functions)"
},
{
"label": "package (functions)",
"command": "mvn clean package",
"type": "shell",
"group": {
"kind": "build",
"isDefault": true
}
}
]
}
251 changes: 250 additions & 1 deletion instrumentation/java/azure-functions/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,250 @@
# splunk-opentelemetry-examples
# Instrumenting a Java Azure Function with OpenTelemetry

This example demonstrates how to instrument an serverless Azure function written in
Java using OpenTelemetry, and then export the data to Splunk Observability
Cloud. We'll use Java 21 for this example, but the steps earlier Java versions are
similar.

## Prerequisites

The following tools are required to deploy Java Azure functions:

* An Azure account with permissions to create and execute Azure functions
* [Visual Studio Code](https://code.visualstudio.com/)
* Azure Functions extension for Visual Studio Code (installed using Visual Studio Code)
* Java Platform extension for Visual Studio Code (installed using Visual Studio Code)

## Application Overview

If you just want to build and deploy the example, feel free to skip this section.

The application used for this example is a simple Hello World application.

We added a helper class named [SplunkTelemetryConfiguration](./SplunkTelemetryConfigurator.cs), and included code to
assist with initializing the tracer, as well as a custom logger to inject the trace context.

The tracer initialization is based on the example found in
[Instrument Java Azure functions for Splunk Observability Cloud](https://docs.splunk.com/observability/en/gdi/get-data-in/serverless/azure/instrument-azure-functions-java.html):

````
public static TracerProvider ConfigureSplunkTelemetry()
{
// Get environment variables from function configuration
// You need a valid Splunk Observability Cloud access token and realm
var serviceName = Environment.GetEnvironmentVariable("WEBSITE_SITE_NAME") ?? "Unknown";
var accessToken = Environment.GetEnvironmentVariable("SPLUNK_ACCESS_TOKEN")?.Trim();
var realm = Environment.GetEnvironmentVariable("SPLUNK_REALM")?.Trim();
ArgumentNullException.ThrowIfNull(accessToken, "SPLUNK_ACCESS_TOKEN");
ArgumentNullException.ThrowIfNull(realm, "SPLUNK_REALM");
var builder = Sdk.CreateTracerProviderBuilder()
// Use Add[instrumentation-name]Instrumentation to instrument missing services
// Use Nuget to find different instrumentation libraries
.AddHttpClientInstrumentation(opts =>
{
// This filter prevents background (parent-less) http client activity
opts.FilterHttpWebRequest = req => Activity.Current?.Parent != null;
opts.FilterHttpRequestMessage = req => Activity.Current?.Parent != null;
})
// Use AddSource to add your custom DiagnosticSource source names
//.AddSource("My.Source.Name")
// Creates root spans for function executions
.AddSource("Microsoft.Azure.Functions.Worker")
.SetSampler(new AlwaysOnSampler())
.ConfigureResource(configure => configure
.AddService(serviceName: serviceName, serviceVersion: "1.0.0")
// See https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/src/OpenTelemetry.Resources.Azure
// for other types of Azure detectors
.AddAzureAppServiceDetector())
.AddOtlpExporter(opts =>
{
opts.Endpoint = new Uri($"https://ingest.{realm}.signalfx.com/v2/trace/otlp");
opts.Protocol = OtlpExportProtocol.HttpProtobuf;
opts.Headers = $"X-SF-TOKEN={accessToken}";
})
// Add the console exporter, which is helpful for debugging as the
// spans get written to the console but should be removed in production
.AddConsoleExporter();
return builder.Build()!;
}
````

The custom logger injects the trace context as follows:

````
public static ILogger<T> ConfigureLogger<T>()
{
var loggerFactory = LoggerFactory.Create(logging =>
{
logging.ClearProviders(); // Clear existing providers
logging.Configure(options =>
{
options.ActivityTrackingOptions = ActivityTrackingOptions.SpanId
| ActivityTrackingOptions.TraceId
| ActivityTrackingOptions.ParentId
| ActivityTrackingOptions.Baggage
| ActivityTrackingOptions.Tags;
}).AddConsole(options =>
{
options.FormatterName = "splunkLogsJson";
});
logging.AddConsoleFormatter<SplunkTelemetryConsoleFormatter, ConsoleFormatterOptions>();
});
return loggerFactory.CreateLogger<T>();
}
````

The [Program.cs file](./Program.cs) was then modified to configure
OpenTelemetry using the helper class as follows:

````
using OpenTelemetry.Trace;
using SplunkTelemetry;
var tracerProvider = SplunkTelemetryConfigurator.ConfigureSplunkTelemetry();
var host = new HostBuilder()
.ConfigureFunctionsWorkerDefaults()
.ConfigureServices(services => services.AddSingleton(tracerProvider))
.Build();
````

And then the [Azure function](./azure_function_java8_opentelemetry_example.cs) was modified to configure
the logger used by the application:
````
public azure_function_java8_opentelemetry_example(ILogger<azure_function_java8_opentelemetry_example> logger)
{
_logger = SplunkTelemetryConfigurator.ConfigureLogger<azure_function_java8_opentelemetry_example>();
}
````

These code changes required a number of packages to be added to the azure-functions.csproj file:

````
<ItemGroup>
...
<PackageReference Include="OpenTelemetry" Version="1.10.0" />
<PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.10.0" />
<PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.10.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.10.0" />
<PackageReference Include="OpenTelemetry.Resources.Azure" Version="1.0.0-beta.9" />
</ItemGroup>
````

The `local.settings.json` file was then updated to include the Splunk realm and access token which is
used for local testing:

````
{
"IsEncrypted": false,
"Values": {
"AzureWebJobsStorage": "",
"FUNCTIONS_WORKER_RUNTIME": "java-isolated",
"SPLUNK_REALM": "<Splunk Realm i.e. us0, us1, eu0, etc. >",
"SPLUNK_ACCESS_TOKEN": "<Splunk Observability Cloud Access Token>"
}
}
````

## Build and Deploy

Open the following project using Visual Studio Code:

````
splunk-opentelemetry-examples/instrumentation/java/azure-functions
````

### Create a Function App in Azure

Create a Function App in Azure if you don't already have one. For my example,
I used `opentelemetry-java-examples` as the function name, and used the region of “West US 2”
with Java 21 as the runtime.

![Azure Function App](./images/azure-function-app.png)

### Create a Deployment Slot (Optional)

By default, Azure will use a deployment slot named "Production" for an Azure Function App.
This results in OpenTelemetry using a `deployment.environment` setting of "Production" as well,
which may not be desired.

To use a different `deployment.environment` value, we can create a different deployment slot instead.

In my example, I created a deployment slot named "test".

![Deployment Slot](./images/deployment-slot.png)

### Set Environment Variables

To allow OpenTelemetry to send trace data to Splunk Observability Cloud,
we need to set the SPLUNK_REALM and SPLUNK_ACCESS_TOKEN environment variables
for our Azure Function App:

![Environment Variables](./images/env-vars.png)

### Build and Deploy the Azure Function

In the Azure section of Visual Studio Code, right click on the deployment slot of interest
and select `Deploy to Slot`.

![Deploy](./images/deploy.png)

It will ask you to confirm:

![Confirm Deploy](./images/confirm-deploy.png)

### Test the Azure Function

Copy the function URL from the Azure function:

![Function URL](./images/function-url.png)

Then point your browser to that URL, it should return:

````
Hello, World!
````

### View Traces in Splunk Observability Cloud

After a minute or so, you should start to see traces for the serverless function
appearing in Splunk Observability Cloud:

![Trace](./images/trace.png)

### Add Trace Context to Logs

Logs generated by an Azure function get sent to Application Insights.
Various methods exist for ingesting logs into Splunk platform from Application Insights,
such as the
[Splunk Add-on for Microsoft Cloud Services](https://splunkbase.splunk.com/app/3110).

Once the logs are in Splunk platform, they can be made available to
Splunk Observability Cloud using Log Observer Connect.

In the following example,
we can see that the trace context was injected successfully into the logs
using the custom logging changes described above:

````
{
"event_id": 0,
"log_level": "information",
"category": "example.azure_function_java8_opentelemetry_example",
"message": "C# HTTP trigger function processed a request.",
"timestamp": "2024-12-03T23:18:17.2770657Z",
"service.name": "opentelemetry-examples",
"severity": "INFO",
"span_id": "c6667cb0450822dd",
"trace_id": "c5580e362f333788634779f64220a087",
"parent_id": "2c06698f7f40edb8",
"tag_az.schema_url": "https://opentelemetry.io/schemas/1.17.0",
"tag_faas.execution": "25fc5264-f946-4c63-b561-822b7c2ccddd"
}
````

This will ensure full correlation between traces generated by the OpenTelemetry instrumentation
with metrics and logs.
7 changes: 7 additions & 0 deletions instrumentation/java/azure-functions/host.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"version": "2.0",
"extensionBundle": {
"id": "Microsoft.Azure.Functions.ExtensionBundle",
"version": "[4.*, 5.0.0)"
}
}
Loading

0 comments on commit 8f09ac5

Please sign in to comment.