Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: document Prometheus headers #293

Merged
merged 2 commits into from
Nov 27, 2024
Merged

chore: document Prometheus headers #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ee8455
chore: document prometheus headers support
markphelps Nov 27, 2024
bb0e012
chore: add example
markphelps Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions configuration/analytics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,15 @@

</Tab>
</Tabs>

### Custom Headers

You can also add custom headers to the Prometheus requests by setting the `analytics.storage.prometheus.headers` configuration property. This can be useful if you are using a proxy or need to add additional authentication headers.

Check warning on line 109 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.So] Don't start a sentence with 'so '

Raw Output:
{"message": "[Openly.So] Don't start a sentence with 'so '", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 109, "column": 11}}}, "severity": "WARNING"}

```yaml
analytics:
storage:
prometheus:
headers:
"Authorization": "Bearer <token>"
```

Check failure on line 117 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / lint 

Insert `⏎`
1 change: 1 addition & 0 deletions configuration/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,10 +467,11 @@

#### Analytics: Prometheus

| Property | Description | Default | Since |

Check failure on line 470 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / lint 

Insert `····································`
| ------------------------------------ | ----------------------------------- | ------- | ------- |

Check failure on line 471 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / lint 

Replace `-----------------------------------` with `-----------------------------------------------------------------------`
| analytics.storage.prometheus.enabled | Enable Prometheus support | false | v1.52.0 |

Check failure on line 472 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / lint 

Insert `····································`
| analytics.storage.prometheus.url | URL to connect to prometheus server | | v1.52.0 |

Check failure on line 473 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / lint 

Insert `····································`
| analytics.storage.prometheus.headers | Additional headers to send with Prometheus requests (map[string]string) | | v1.52.1 |

Check failure on line 474 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / lint 

Replace `··|·Additional·headers·to·send·with·Prometheus·requests·(map[string]string)·|··············` with `·|·Additional·headers·to·send·with·Prometheus·requests·(map[string]string)·|`

### Metrics

Expand Down
Loading