⚙️ Ruby SDK configuration
Use the advanced options below to configure Helios Ruby OpenTelemetry SDK, as arguments to the Helios::OpenTelemetry::SDK.initialize() method or as environment variables.
Mandatory parameters
| Parameter | Environment variable | Description | Type | Default value |
|---|---|---|---|---|
api_token | HS_TOKEN | The Helios account token (generated by Helios automatically). | String | - |
service_name | HS_SERVICE_NAME | Service name may contain letters, digits, hyphens and underscores only and cannot be empty. It may range between 3 to 64 characters. | String | - |
Optional parameters
Enabling or disabling the instrumentation
| Parameter | Environment variable | Description | Type | Default value |
|---|---|---|---|---|
enabled | - | When set to True the instrumentation is enabled. | Boolean | False |
Other parameters
| Parameter | Environment variable | Description | Type | Default value |
|---|---|---|---|---|
environment | HS_ENVIRONMENT | The environment where the service runs (dev/staging/production/etc.) | String | - |
debug | HS_DEBUG | Enable debug prints for troubleshooting. | Boolean | False |
metadata_only | HS_METADATA_ONLY | When set to True, the instrumentation will only collect metadata and not collect payload data and headers data. | Boolean | False |
Updated 5 months ago
Learn more