Skip to content

Commit

Permalink
docs: update content of env var tables (#3042)
Browse files Browse the repository at this point in the history 
* docs: update content of env var tables

* docs: formatting updates
  • Loading branch information
@melissahenderson
melissahenderson authored Nov 6, 2024
1 parent b912bff commit cf5f235
Show file tree
Hide file tree
Showing 4 changed files with 189 additions and 97 deletions.
30 changes: 22 additions & 8 deletions packages/documentation/src/content/docs/overview/concepts/telemetry.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,15 +161,29 @@ You must deploy your own OTEL Collector that acts as a sidecar container to Rafi

### Telemetry environment variables

<div class="overflow-table wide-column">
#### Required

When the `ENABLE_TELEMETRY` variable is `true`, the following are required.

<div class="overflow-table">

| Variable name | Type | Description |
| ------------- | ---- | ----------- |
| `INSTANCE_NAME` | String | Your Rafiki instance's name used to communicate for telemetry and auto-peering. For telemetry, it's used to distinguish between the different instances pushing data to the telemetry collector. | Y |

</div>

#### Optional

<div class="overflow-table">

| Variable name | Type | Description | Required |
| -------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `ENABLE_TELEMETRY` | Boolean | Enables the telemetry service on Rafiki. Defaults to `true`. | N |
| `LIVENET` | Boolean | Determines where to send metrics. Defaults to `false`, resulting in metrics being sent to the testnet OTEL Collector. <p>Set to `true` on production environments dealing with real money.</p> | N |
| `OPEN_TELEMETRY_COLLECTOR_URLS` | String | A CSV of URLs for OTEL Collectors (e.g., `http://otel-collector-NLB-e3172ff9d2f4bc8a.elb.eu-west-2.amazonaws.com:4317,http://happy-life-otel-collector:4317`). | N |
| `OPEN_TELEMETRY_EXPORT_INTERVAL` | Number | Indicates, in milliseconds, how often the instrumented Rafiki instance should send metrics. Defaults to `15000`. | N |
| `TELEMETRY_EXCHANGE_RATES_URL` | String | <p>Defines the endpoint Rafiki will query for exchange rates. Used as a fallback if/when [exchange rates](/integration/requirements/exchange-rates) aren’t provided.</p><p>When set, the response format of the external exchange rates API should be of type `rates`, as is expected by the rate service.</p><p>Defaults to `https://telemetry-exchange-rates.s3.amazonaws.com/exchange-rates-usd.json`, which points to a public S3 that has the previously mentioned required format, updated daily.</p> | N |
| Variable name | Type | Description |
| ------------- | ---- | ----------- |
| `ENABLE_TELEMETRY` | Boolean | Enables the telemetry service on Rafiki. Defaults to `true`. |
| `LIVENET` | Boolean | Determines where to send metrics. Defaults to `false`, resulting in metrics being sent to the testnet OTEL Collector. <p>Set to `true` on production environments dealing with real money.</p> |
| `OPEN_TELEMETRY_COLLECTOR_URLS` | String | A CSV of URLs for OTEL Collectors (e.g., `http://otel-collector-NLB-e3172ff9d2f4bc8a.elb.eu-west-2.amazonaws.com:4317,http://happy-life-otel-collector:4317`). |
| `OPEN_TELEMETRY_EXPORT_INTERVAL` | Number | Indicates, in milliseconds, how often the instrumented Rafiki instance should send metrics. Defaults to`15000`. |
| `TELEMETRY_EXCHANGE_RATES_URL` | String | <p>Defines the endpoint Rafiki will query for exchange rates. Used as a fallback if/when [exchange rates](/integration/requirements/exchange-rates) aren’t provided.</p><p>When set, the response format of the external exchange rates API should be of type `rates`, as is expected by the rate service.</p><p>Defaults to `https://telemetry-exchange-rates.s3.amazonaws.com/exchange-rates-usd.json`, which points to a public S3 that has the previously mentioned required format, updated daily.</p> |

</div>

Expand Down
Loading

0 comments on commit cf5f235

Please sign in to comment.