Create Dynatrace telemetry instances
The installed provider is shared with all users of your Akamas installation and can monitor many different systems, by configuring appropriate telemetry provider instances.
To create an instance of the Dynatrace provider, build a YAML file (instance.yml
in this example) with the definition of the instance:
Then you can create the instance for the system
using the Akamas CLI:
Configuration options
When you create an instance of the Dynatrace provider, you should specify some configuration information to allow the provider to correctly extract and process metrics from Dynatrace.
You can specify configuration information within the config
part of the YAML of the instance definition.
Required properties
url
- URL of the Dynatrace installation API (see https://www.dynatrace.com/support/help/extend-dynatrace/dynatrace-api/ to retrieve the URL of your installation)token
- A Dynatrace API Token with the proper permissions
Collect additional metrics
You can collect additional metrics with the Dynatrace provider by using the metrics
field:
Configure a proxy for Dynatrace
In the case in which Akamas cannot reach directly your Dynatrace installation, you can configure an HTTP proxy by using the proxy
field:
Telemetry instance reference
This section reports the complete reference for the definition of a telemetry instance.
This table shows the reference for the config
section within the definition of the Dynatrace provider instance:
Field | Type | Value restrictions | Required | Default Value | Description |
---|---|---|---|---|---|
| String | It should be a valid URL | Yes | The URL of the Dynatrace installation API (see the official reference) | |
| String | Yes | The Dynatrace API Token the provider should use to interact with Dynatrace. The token should have sufficient permissions. | ||
| Object | See Proxy options reference | No | The specification of the HTTP proxy to use to communicate with Dynatrace. | |
| String | true, false | No | true | If set to true the provider will inform dynatrace of the configuration change event which will be visible in the Dynatrace UI. |
| Object | No | A set of global tags to match Dynatrace entities. The provider uses these tags to apply a default filtering of Dynatrace entities for every component. |
Proxy options reference
This table reports the reference for the config
→ proxy
section within the definition of the Dynatrace provider instance:
Field | Type | Value restrictions | Required | Default value | Description |
---|---|---|---|---|---|
| String | It should be a valid URL | Yes | The URL of the HTTP proxy to use to communicate with the Dynatrace installation API | |
| Number (integer) | 1 < | Yes | The port at which the HTTP proxy listens for connections | |
| String | No | The username to use when authenticating against the HTTP proxy, if necessary | ||
| String | No | The username to use when authenticating against the HTTP proxy, if necessary |
Metrics options reference
This table reports the reference for the metrics
section within the definition of the Dynatrace provider instance. The section contains a collection of objects with the following properties:
Field | Type | Value Restrictions | Required | Default value | Description |
---|---|---|---|---|---|
| String | It must be an Akamas metric | Yes | The name of an Akamas metric that should map to the new metric you want to gather | |
| String | A valid Dynatrace metric | Yes | The Dynatrace query to use to extract | |
| Array of strings | - | No | The list of Dynatrace labels that should be retained when gathering the | |
| Key-Value | - | No | Static labels that will be attached to metric samples | |
| String | No | avg | The aggregation to perform if the mergeEntities property under the extras section is set to true | |
| Object | Only the parameter | No | Section for additional properties |
Use cases
This section reports common use cases addressed by this provider.
Collect system metrics
Check the Linux optimization pack for a list of all the system metrics available in Akamas.
As a first step to start extracting metrics from Dyntrace, generate your API token and make sure it has the right permissions.
As a second step, choose a strategy to map your Linux component (MyLinuxComponent) with the corresponding Dyntrace entity.
Let’s assume you want to map by id your Dynatrace entity, you can find the id in the URL bar of a Dyntrace dashboard of the entity:
![](https://docs.akamas.io/~gitbook/image?url=https%3A%2F%2F3774185011-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FJSNpKvJ3IYa5Vo69I0ed%252Fuploads%252Fgit-blob-d2f85e5277af378c5cf1bbeb04b6d61a4db15d6f%252Fimage-20200302-144709.png%3Falt%3Dmedia&width=768&dpr=4&quality=100&sign=f281244c&sv=1)
Grab the id and add it to the Linux component definition:
You can leverage the name of the entity as well:
As a third and final step, once the component is all set, you can create an instance of the Dynatrace provider and then build your first studies:
Last updated