Skip to content

README.md

Latest commit

 

History

History
169 lines (119 loc) · 5.43 KB

README.md

File metadata and controls

169 lines (119 loc) · 5.43 KB
Raw

Example

This example instruments a simple HTTP server-client application.

The application is configured to send spans, metrics, and logs to a local instance of the OpenTelemetry Collector, which propagates them to Splunk Observability Cloud.

Prerequisites

Usage

OpenTelmemtry Collector

Run the OpenTelemetry Collector and Jaeger instance:

SPLUNK_ACCESS_TOKEN=<access_token> SPLUNK_HEC_TOKEN=<access_token> SPLUNK_HEC_URL=<url> docker compose up -d

Run the instrumented application:

export OTEL_LOGS_EXPORTER=otlp
export OTEL_SERVICE_NAME="splunk-otel-go-example"
export OTEL_RESOURCE_ATTRIBUTES="deployment.environment=$(whoami)"
go run .

You can find the collected telemetry in:

Cleanup:

docker compose down

Splunk Distribution of the OpenTelemetry Collector

Run the Splunk Distribution of the OpenTelemetry Collector instance:

SPLUNK_ACCESS_TOKEN=<access_token> SPLUNK_HEC_TOKEN=<access_token> SPLUNK_HEC_URL=<url> docker compose -f docker-compose-splunk.yaml up -d

Run the instrumented application:

export OTEL_LOGS_EXPORTER=otlp
export OTEL_SERVICE_NAME="splunk-otel-go-example"
export OTEL_RESOURCE_ATTRIBUTES="deployment.environment=$(whoami)"
go run .

You can find the collected telemetry in:

Cleanup:

docker compose -f docker-compose-splunk.yaml down

Direct to Splunk Observability Cloud

Run the instrumented application:

export OTEL_SERVICE_NAME="splunk-otel-go-example"
export OTEL_RESOURCE_ATTRIBUTES="deployment.environment=$(whoami)"
SPLUNK_REALM=<realm> SPLUNK_ACCESS_TOKEN=<access_token> go run .

You can find the collected telemetry in:

Splunk AppDynamics SaaS via the OpenTelemetry Collector

Run the the OpenTelemetry Collector instance:

APPD_ACCOUNT=<account> APPD_API_KEY=<api_key> docker compose -f docker-compose-appd.yaml up -d

Run the instrumented application:

export OTEL_SERVICE_NAME="splunk-otel-go-example"
export OTEL_RESOURCE_ATTRIBUTES="service.namespace=$(whoami)"
go run .

You can find the collected telemetry in:

Cleanup:

docker compose -f docker-compose-appd.yaml down

FIPS mode - Linux

Note

As BoringSSL is FIPS 140-2 certified, an application built using GOEXPERIMENT=boringcrypto is more likely to be FIPS 140-2 compliant. Yet Google does not provide any liability about the suitability of this code in relation to the FIPS 140-2 standard. More information can be found here.

Run the instrumented applications using boringcrypto. For example:

CGO_ENABLED=1 GOEXPERIMENT=boringcrypto go run .

FIPS mode - Windows

Note

Microsoft maintains a fork of Go that is configurable to use a FIPS 140-2 compliant cryptography. All Go applications running on Windows and intended to be FIPS 140-2 compliant, should be built using this fork. More information can be found here.

Build the instrumented application using the container image containing the Microsoft build of Go. Make sure to set GOOS=windows GOEXPERIMENT=cngcrypto and add the requirefips Go build tag. For example, using Git Bash on Windows in the root of the repository:

MSYS_NO_PATHCONV=1 docker run --rm -w /app -v $(pwd):/app mcr.microsoft.com/oss/go/microsoft/golang sh -c \
"cd example && GOOS=windows GOEXPERIMENT=cngcrypto go build -tags=requirefips"

Before running the application make sure to enable the Windows FIPS policy. For testing purposes, Windows FIPS policy can be enabled via the registry key HKLM\SYSTEM\CurrentControlSet\Control\Lsa\FipsAlgorithmPolicy dword value Enabled set to 1.

Resources

The information about SPLUNK_ACCESS_TOKEN and can be found here.

The information about SPLUNK_HEC_TOKEN and SPLUNK_HEC_URL can be found here.

The information about APPD_ prefixed environment variables can be found here.