OneAgent-SDK-for-Go

module

v1.1.0 Latest Latest Go to latest Published: Jun 7, 2022 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Dynatrace/OneAgent-SDK-for-Go

Links

Open Source Insights

README ¶

Dynatrace OneAgent SDK for Go

This SDK provides functionality for Go applications to enrich their log messages and OpenTelemetry traces with metadata useful in a Dynatrace environment.

Package contents

examples: contains sample applications, which demonstrate usage of the SDK. See readme inside the directory for more details.
LICENSE: license under which the whole SDK and sample applications are published.

Requirements

Some features require the OneAgent Go code module to be injected successfully (i.e. deep monitoring being activated), while other features work without it. OneAgent is required in any case.

OneAgent SDK for Go	Minimum OneAgent version	Support status
1.1.0	1.245	Supported
1.0.0	1.233	Supported
0.1.0	1.233	Not supported

Integration

Using the functions in this module without OneAgent present should be perfectly fine. The functions will then return invalid values or an error. This may happen in the following cases:

OneAgent is not present.
OneAgent does not support the SDK version (check the required version).
Some other reason specific to a particular function.

Troubleshooting

If the SDK can not connect to OneAgent, verify that a matching version of OneAgent is used and deep monitoring is activated. Check that the OneAgent Go log file contains the following log message:

OneAgent SDK has been resolved successfully

Features

Common API concepts of the Dynatrace OneAgent SDK are explained in the Dynatrace OneAgent SDK repository. An overview of features in this SDK will follow, see the sdk package documentation for detailed information.

Feature	SDK Version
Enrichment metadata	≥ 1.1.0
TraceContext	≥ 1.0.0

Help & Support

Support policy

Starting with version 1.0.0, Dynatrace OneAgent SDK for Go has GA status. The features are fully supported by Dynatrace.

For a detailed support policy see Dynatrace OneAgent SDK help.

Get Help

Ask a question in the product forums
Read the product documentation

Open a GitHub issue to

Report minor defects, minor items or typos
Ask for improvements or changes in the SDK API
Ask any questions related to the community effort

SLAs don't apply for GitHub tickets.

Customers can open a ticket on the Dynatrace support portal to

Get support from the Dynatrace technical support engineering team
Manage and resolve product related technical issues

SLAs apply according to the customer's support level.

Release Notes

Directories ¶

Path	Synopsis
sdk Package sdk provides the OneAgentSDK interface, which is the entry point to all OneAgent SDK for Go functionality.	Package sdk provides the OneAgentSDK interface, which is the entry point to all OneAgent SDK for Go functionality.
internal
native Package native contains functionality that does not require the OneAgent Go code module.	Package native contains functionality that does not require the OneAgent Go code module.
trace

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Version	Description
1.1.0	Added support for enrichment metadata
1.0.0	Initial GA release
0.1.0	Initial Alpha release