https://github.com/steadybit/extension-instana
https://github.com/steadybit/extension-instana
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/steadybit/extension-instana
- Owner: steadybit
- License: mit
- Created: 2023-12-20T13:22:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-09T17:53:30.000Z (5 months ago)
- Last Synced: 2026-02-09T21:19:11.585Z (5 months ago)
- Language: Go
- Homepage: https://hub.steadybit.com/extension/com.steadybit.extension_instana
- Size: 448 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Steadybit extension-instana
A [Steadybit](https://www.steadybit.com/) extension for [Instana](https://www.ibm.com/de-de/products/instana).
Learn about the capabilities of this extension in our [Reliability Hub](https://hub.steadybit.com/extension/com.steadybit.extension_instana).
## Configuration
| Environment Variable | Helm value | Meaning | Required | Default |
|---------------------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|
| `STEADYBIT_EXTENSION_BASE_URL` | | The Instana Base Url, like `https://$UNIT-$TENANT.instana.io` | yes | |
| `STEADYBIT_EXTENSION_API_TOKEN` | | The Instana [API Token](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api#tokens), see the required permissions below | yes | |
The extension supports all environment variables provided by [steadybit/extension-kit](https://github.com/steadybit/extension-kit#environment-variables).
When installed as linux package this configuration is in`/etc/steadybit/extension-instana`.
## Permissions
The extension requires the following scopes:
- "Configuration of Events, Alerts and Smart Alerts for Applications, websites and mobile apps" - `canConfigureCustomAlerts` (if you want to use the "Create Maintenance Window" action)
## Installation
### Kubernetes
Detailed information about agent and extension installation in kubernetes can also be found in
our [documentation](https://docs.steadybit.com/install-and-configure/install-agent/install-on-kubernetes).
#### Recommended (via agent helm chart)
All extensions provide a helm chart that is also integrated in the
[helm-chart](https://github.com/steadybit/helm-charts/tree/main/charts/steadybit-agent) of the agent.
You must provide additional values to activate this extension.
```
--set extension-instana.enabled=true \
--set extension-instana.instana.baseUrl={{YOUR_BASE_URL}} \
--set extension-instana.instana.apiToken={{YOUR_API_TOKEN}} \
```
Additional configuration options can be found in
the [helm-chart](https://github.com/steadybit/extension-instana/blob/main/charts/steadybit-extension-instana/values.yaml) of the
extension.
#### Alternative (via own helm chart)
If you need more control, you can install the extension via its
dedicated [helm-chart](https://github.com/steadybit/extension-instana/blob/main/charts/steadybit-extension-instana).
```bash
helm repo add steadybit-extension-instana https://steadybit.github.io/extension-instana
helm repo update
helm upgrade steadybit-extension-instana \
--install \
--wait \
--timeout 5m0s \
--create-namespace \
--namespace steadybit-agent \
--set instana.baseUrl={{YOUR_BASE_URL}} \
--set instana.apiToken={{YOUR_API_TOKEN}} \
steadybit-extension-instana/steadybit-extension-instana
```
### Linux Package
Please use
our [agent-linux.sh script](https://docs.steadybit.com/install-and-configure/install-agent/install-on-linux-hosts)
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-instana` 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](https://docs.steadybit.com/install-and-configure/install-agent/extension-registration) for more
information about extension registration and how to verify.
## Importing your own certificates
You may want to import your own certificates for connecting to Jenkins instances 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.
```yaml
instana:
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:
```shell
kubectl create configmap -n steadybit-agent instana-self-signed-ca --from-file=./self-signed-ca.crt
```
```yaml
extraVolumeMounts:
- name: extra-certs
mountPath: /etc/ssl/extra-certs
readOnly: true
extraVolumes:
- name: extra-certs
configMap:
name: instana-self-signed-ca
extraEnv:
- name: SSL_CERT_DIR
value: /etc/ssl/extra-certs:/etc/ssl/certs
```
## 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