⚙️ Go SDK configuration
Use the advanced options below to configure Helios Go SDK.
Mandatory parameters
| Parameter | Environment variable | Description | Type | Default value |
|---|---|---|---|---|
apiToken | - | The Helios account token (generated by Helios automatically). | String | - |
serviceName | - | Service name may contain letters, digits, hyphens and underscores only and cannot be empty. It may range between 3 to 64 characters. | String | - |
environment | - | The environment where the service currently runs. When running in CI, the CI provider is used (GitHub Actions, GitLab Pipeline, CircleCI, Jenkins or Travis CI). | String | - |
Optional parameters
Enabling or disabling the instrumentation
| Parameter | Environment variable | Description | Type | Default value |
|---|---|---|---|---|
| - | HS_DISABLED | When set to true the instrumentation is disabled. | Boolean | false |
Other parameters
| Parameter | Environment variable | Description | Type | Default value |
|---|---|---|---|---|
samplingRatio | HS_SAMPLING_RATIO | How many of the traces starting in this service should be sampled. Value should be any number between 0.0 and 1.0. | String | - |
collectorInsecure | HS_COLLECTOR_INSECURE | Reports data to the collector over HTTP scheme, instead of the default HTTPS (cannot be used with the default Helios collector endpoint). | Boolean (in code) String (in env var) | false |
collectorEndpoint | HS_COLLECTOR_ENDPOINT | An alternative endpoint that collects the exported spans (without the URL path). | String | The official Helios collector endpoint. |
collectorPath | HS_COLLECTOR_PATH | The specific URL path in the alternative endpoint set above. | String | The official Helios collector path. |
commitHash | HS_COMMIT_HASH | The commit hash (SHA1) of the current run of the service. When running in CI, the CI provider's environment variables are used. Supported in GitHub Actions, GitLab Pipeline, CircleCI and Travis CI. | String | - |
metadataOnly | HS_METADATA_ONLY | When set to true, the instrumentation will only collect metadata and not collect payload data and headers data. | Boolean (in code) String (in env var) | false |
HS_SERVICE_NAMESPACE | The standard OTel resource attribute used to associate resources with teams. | String | - |
Updated 7 months ago
Learn more