https://github.com/steadybit/extension-debug
steadybit-debug extension
https://github.com/steadybit/extension-debug
Last synced: 4 months ago
JSON representation
steadybit-debug extension
- Host: GitHub
- URL: https://github.com/steadybit/extension-debug
- Owner: steadybit
- License: mit
- Created: 2024-01-31T10:03:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-02T14:43:49.000Z (4 months ago)
- Last Synced: 2026-03-02T17:17:41.945Z (4 months ago)
- Language: Go
- Size: 449 KB
- Stars: 0
- 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-debug
Run [steadybit-debug](https://github.com/steadybit/steadybit-debug) as extension for gather denug information of agent and extension.
## Configuration
| Environment Variable | Helm value | Meaning | Required | Default |
|-----------------------------------------------------------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------|----------|-------------------------|
The extension supports all environment variables provided by [steadybit/extension-kit](https://github.com/steadybit/extension-kit#environment-variables).
## 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-debug.enabled=true \
```
Additional configuration options can be found in
the [helm-chart](https://github.com/steadybit/extension-debug/blob/main/charts/steadybit-extension-debug/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-debug/blob/main/charts/steadybit-extension-debug).
```bash
helm repo add steadybit-extension-debug https://steadybit.github.io/extension-debug
helm repo update
helm upgrade steadybit-extension-debug \
--install \
--wait \
--timeout 5m0s \
--create-namespace \
--namespace steadybit-extension \
steadybit-extension-debug/steadybit-extension-debug
```
## 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.
## 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