-
Notifications
You must be signed in to change notification settings - Fork 5
docs: improve observability / monitoring documentation #310
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.
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
Open
Georg (D3luxee)
wants to merge
15
commits into
main
Choose a base branch
from
gd/observability_docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
cae025f
docs: document observability tap
D3luxee 0d7a580
docs: add a list of available data that our system provides
D3luxee 11047d0
make prometheus api paths more specific for labels
D3luxee f8d5542
make loki api paths more specific for labels
D3luxee 0741967
make menu entry nicer
D3luxee 122f719
Correctly refer to GameFabric Help Center
D3luxee bf60f47
Update src/multiplayer-servers/monitoring/introduction.md
D3luxee 61799ce
Update src/multiplayer-servers/monitoring/introduction.md
D3luxee 3aa2376
Update src/multiplayer-servers/monitoring/obs-tap.md
D3luxee 44fc8c4
Update src/multiplayer-servers/monitoring/obs-tap.md
D3luxee f4685e3
Update src/multiplayer-servers/monitoring/obs-tap.md
D3luxee 19bfd67
Update src/multiplayer-servers/monitoring/obs-tap.md
D3luxee ca7a662
fix ops-tap after merging some suggestiosn
D3luxee b766dcb
Potential fix for pull request finding
D3luxee c421afa
Adjust numbering
D3luxee File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # Observability tap | ||
|
|
||
| The observability tap gives you direct, read-only access to the Prometheus-compatible metrics API and the Loki-compatible logs API for your GameFabric installation. Use it to display data in your own Grafana instance or in any other observability tool that supports these APIs. | ||
|
|
||
| ## Requesting access | ||
|
|
||
| Access to the observability tap is not enabled by default. To request it, contact your **Customer Success Manager** or raise a request through the **GameFabric Help Center**. Once approved, you receive the credentials needed to authenticate against the endpoints. | ||
|
|
||
| ## Endpoints | ||
|
|
||
| All observability tap endpoints are available under your installation's base URL: | ||
|
|
||
| ``` | ||
|
D3luxee marked this conversation as resolved.
D3luxee marked this conversation as resolved.
|
||
| https://<your-installation>.gamefabric.dev/observability/ | ||
| ``` | ||
|
|
||
| Replace `<your-installation>` with your installation name. | ||
|
|
||
| The two sub-paths expose the respective APIs: | ||
|
|
||
| | API | Base URL | | ||
| | --- | -------- | | ||
| | Prometheus-compatible metrics (VictoriaMetrics) | `https://<your-installation>.gamefabric.dev/observability/metrics/` | | ||
| | Loki-compatible logs | `https://<your-installation>.gamefabric.dev/observability/logs/` | | ||
|
|
||
| ## Querying metrics | ||
|
|
||
| The metrics endpoint is compatible with the [VictoriaMetrics MetricsQL](https://docs.victoriametrics.com/metricsql/) query language, which is a superset of PromQL. Any tool that supports PromQL also works against this endpoint. | ||
|
|
||
| The following Prometheus HTTP API paths are available under the metrics endpoint: | ||
|
|
||
|
|
||
| - `/observability/metrics/api/v1/query` — instant query | ||
| - `/observability/metrics/api/v1/query_range` — range query | ||
| - `/observability/metrics/api/v1/series` — series metadata | ||
| - `/observability/metrics/api/v1/labels` — label names | ||
| - `/observability/metrics/api/v1/label/<label_name>/values` — label values | ||
| - `/observability/metrics/api/v1/metadata` — metric metadata | ||
|
Copilot marked this conversation as resolved.
|
||
| - `/observability/metrics/api/v1/status/buildinfo` — build information | ||
|
|
||
| Refer to the [VictoriaMetrics MetricsQL reference](https://docs.victoriametrics.com/metricsql/) for the full query language documentation. | ||
|
|
||
| ## Querying logs | ||
|
|
||
| The logs endpoint is compatible with the [Loki LogQL](https://grafana.com/docs/loki/latest/query/) query language. | ||
|
|
||
| The following Loki HTTP API paths are available under the logs endpoint: | ||
|
D3luxee marked this conversation as resolved.
|
||
|
|
||
| - `/observability/logs/loki/api/v1/query` — instant query | ||
| - `/observability/logs/loki/api/v1/query_range` — range query | ||
| - `/observability/logs/loki/api/v1/labels` — label names | ||
| - `/observability/logs/loki/api/v1/label/<label_name>/values` — label values | ||
| - `/observability/logs/loki/api/v1/series` — series metadata | ||
|
Copilot marked this conversation as resolved.
|
||
| - `/observability/logs/loki/api/v1/index/stats` — index statistics | ||
| - `/observability/logs/loki/api/v1/tail` — live tail | ||
| - `/observability/logs/loki/api/v1/status/buildinfo` — build information | ||
|
|
||
| Refer to the [Loki LogQL reference](https://grafana.com/docs/loki/latest/query/) for the full query language documentation. | ||
|
|
||
| ## Adding as a Grafana data source | ||
|
|
||
| You can add both endpoints as data sources in your own Grafana instance. | ||
|
|
||
| ### Metrics data source | ||
|
|
||
| 1. In Grafana, go to **Connections > Data sources** and select **Add new data source**. | ||
| 2. Choose **Prometheus** as the data source type. | ||
| 3. Set the **URL** to `https://<your-installation>.gamefabric.dev/observability/metrics/`. | ||
| 4. Under **Authentication**, set the **Authentication method** to **No authentication** | ||
| 5. Under **HTTP headers**, click **Add header** and set **Header** to `Authorization` and **Value** to `Bearer <token>`. Replace `<token>` with the token you receive from your Customer Success Manager. Keep the `Bearer` prefix. | ||
| 1. Select **Save & test** to verify the connection. | ||
|
|
||
|
|
||
| ### Logs data source | ||
|
|
||
| 1. In Grafana, go to **Connections > Data sources** and select **Add new data source**. | ||
| 2. Choose **Loki** as the data source type. | ||
| 3. Set the **URL** to `https://<your-installation>.gamefabric.dev/observability/logs/`. | ||
| 4. Under **Authentication**, set the **Authentication method** to **No authentication** | ||
| 5. Under **HTTP headers**, click **Add header** and set **Header** to `Authorization` and **Value** to `Bearer <token>`. Replace `<token>` with the token you receive from your Customer Success Manager. Keep the `Bearer` prefix. | ||
| 6. Select **Save & test** to verify the connection. | ||
|
|
||
| Once the data sources are configured, you can build dashboards and alerts in your own Grafana instance using the same metrics and logs that power the built-in GameFabric monitoring dashboards. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.