Steadybit extension-dynatrace
A Steadybit extension for Dynatrace.
Learn about the capabilities of this extension in
our Reliability Hub.
Configuration
| Environment Variable |
Helm value |
Meaning |
Required |
Default |
STEADYBIT_EXTENSION_API_BASE_URL |
dynatrace.apiBaseUrl |
The Dynatrace API Base Url, like https://{your-environment-id}.live.dynatrace.com/api |
yes |
|
STEADYBIT_EXTENSION_UI_BASE_URL |
dynatrace.uiBaseUrl |
The Dynatrace UI Base Url, like https://{your-environment-id}.apps.dynatrace.com/ui |
yes |
|
STEADYBIT_EXTENSION_UI_PROBLEMS_PATH |
dynatrace.uiProblemsPath |
The Dynatrace UI Path to the problem details page. The extension will render the link to the problems like this {uiBaseUrl}{uiProblemsPath};pid={problemId} |
yes |
/apps/dynatrace.classic.problems/#problems/problemdetails |
STEADYBIT_EXTENSION_API_TOKEN |
dynatrace.apiToken or dynatrace.existingSecret |
The Dynatrace API Token, see the required scopes below |
yes |
|
STEADYBIT_EXTENSION_INSECURE_SKIP_VERIFY |
dynatrace.insecureSkipVerify |
To not check certificate for on-prem dynatrace installations |
false |
false |
The extension supports all environment variables provided by steadybit/extension-kit.
When installed as linux package this configuration is in/etc/steadybit/extension-dynatrace.
Dynatrace Permissions
The extension requires the following scopes:
entities.read
events.ingest
settings.write (if you want to use the "Create Maintenance Window" action)
problems.read (if you want to use the "Check Problem" action)
Installation
Kubernetes
Detailed information about agent and extension installation in kubernetes can also be found in
our documentation.
Recommended (via agent helm chart)
All extensions provide a helm chart that is also integrated in the
helm-chart of the agent.
You must provide additional values to activate this extension.
--set extension-dynatrace.enabled=true \
--set extension-dynatrace.dynatrace.apiBaseUrl={{YOUR_API_BASE_URL}} \
--set extension-dynatrace.dynatrace.uiBaseUrl={{YOUR_UI_BASE_URL}} \
--set extension-dynatrace.dynatrace.apiToken={{YOUR_API_TOKEN}} \
--set extension-dynatrace.dynatrace.insecureSkipVerify=false \
Additional configuration options can be found in
the helm-chart of the
extension.
Alternative (via own helm chart)
If you need more control, you can install the extension via its
dedicated helm-chart.
helm repo add steadybit-extension-dynatrace https://steadybit.github.io/extension-dynatrace
helm repo update
helm upgrade steadybit-extension-dynatrace \
--install \
--wait \
--timeout 5m0s \
--create-namespace \
--namespace steadybit-agent \
--set dynatrace.apiBaseUrl={{YOUR_API_BASE_URL}} \
--set dynatrace.uiBaseUrl={{YOUR_UI_BASE_URL}} \
--set dynatrace.apiToken={{YOUR_API_TOKEN}} \
steadybit-extension-dynatrace/steadybit-extension-dynatrace`
Importing your own certificates
You may want to import your own certificates for connecting to Gatling Enterprise with self-signed certificates. This can be done in two ways:
Option 1: Using InsecureSkipVerify
The extension provides the insecureSkipVerify option which disables TLS certificate verification. This is suitable for testing but not recommended for production environments.
dynatrace:
insecureSkipVerify: true
Option 2: Mounting custom certificates
Mount a volume with your custom certificates and reference it in extraVolumeMounts and extraVolumes in the helm chart.
This example uses a config map to store the *.crt-files:
kubectl create configmap -n steadybit-agent dynatrace-self-signed-ca --from-file=./self-signed-ca.crt
extraVolumeMounts:
- name: extra-certs
mountPath: /etc/ssl/extra-certs
readOnly: true
extraVolumes:
- name: extra-certs
configMap:
name: dynatrace-self-signed-ca
extraEnv:
- name: SSL_CERT_DIR
value: /etc/ssl/extra-certs:/etc/ssl/certs
Linux Package
Please use
our agent-linux.sh script
to install the extension on your Linux machine. The script will download the latest version of the extension and install
it using the package manager.
After installing, configure the extension by editing /etc/steadybit/extension-dynatrace and then restart the service.
Extension registration
Make sure that the extension is registered with the agent. In most cases this is done automatically. Please refer to
the documentation for more
information about extension registration and how to verify.
Proxy
To communicate to Dynatrace via a proxy, we need the environment variable https_proxy to be set.
This can be set via helm using the extraEnv variable
--set "extraEnv[0].name=HTTPS_PROXY" \
--set "extraEnv[0].value=https:\\user:pwd@CompanyProxy.com:8888"
Version and Revision
The version and revision of the extension:
- are printed during the startup of the extension
- are added as a Docker label to the image
- are available via the
version.txt/revision.txt files in the root of the image