Skip to content

Commit cfd69bc

Browse files
authored
Merge pull request #40 from tinybirdco/feature/fix-broken-links
Fix broken links
2 parents 52839cf + e37d2bd commit cfd69bc

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# Tinybird Organization Metrics Exporter
22

3-
This project uses Tinybird's [Service Data Sources](https://www.tinybird.co/docs/monitoring/organizations#organization-service-data-sources) to aggregate and publish organizational metrics as endpoints in [Prometheus format](https://www.tinybird.co/docs/guides/integrations/consume-api-endpoints-in-prometheus-format) for quick integration with common monitoring tools.
3+
This project uses Tinybird's [Service Data Sources](https://www.tinybird.co/docs/forward/administration/organizations) to aggregate and publish organizational metrics as endpoints in [Prometheus format](https://www.tinybird.co/docs/forward/work-with-data/publish-data/guides/consume-api-endpoints-in-prometheus-format) for quick integration with common monitoring tools.
44

55
## Features
66

7-
- Includes a set of Pipes that consolidate and process organizational metrics.
8-
- Exposes all key metrics through a single Pipe Endpoint in Prometheus format for streamlined monitoring.
9-
- Provides essential insights to help you monitor your usage, detect anomalies, and set up alerts in critical areas such as:
10-
- Data ingestion: Track the volume and frequency of ingested data.
11-
- Pipe endpoint usage: Analyze requests and identify unusual traffic patterns.
12-
- Storage: Monitor storage usage to optimize resources and avoid limits.
13-
- Jobs: Keep track of the status and performance of scheduled jobs.
7+
- Includes a set of Pipes that consolidate and process organizational metrics.
8+
- Exposes all key metrics through a single Pipe Endpoint in Prometheus format for streamlined monitoring.
9+
- Provides essential insights to help you monitor your usage, detect anomalies, and set up alerts in critical areas such as:
10+
- Data ingestion: Track the volume and frequency of ingested data.
11+
- Pipe endpoint usage: Analyze requests and identify unusual traffic patterns.
12+
- Storage: Monitor storage usage to optimize resources and avoid limits.
13+
- Jobs: Keep track of the status and performance of scheduled jobs.
1414

1515
## Get started
1616

1717
### Prerequisites
1818

1919
1. You must have a [Tinybird organization](https://www.tinybird.co/docs/monitoring/organizations).
20-
2. You need to be an admin of the organization to access [organization Service Data Sources](https://www.tinybird.co/docs/monitoring/organizations#organization-service-data-sources).
20+
2. You need to be an admin of the organization to access [organization Service Data Sources](https://www.tinybird.co/docs/forward/administration/organizations).
2121

2222
### Setup
2323

@@ -33,7 +33,7 @@ tb login
3333
tb --cloud deploy --template https://github.com/tinybirdco/tinybird-org-metrics-exporter/tree/main/tinybird
3434
```
3535

36-
#### Use the Prometheus endpoint
36+
#### Use the Prometheus endpoint
3737

3838
Access the Prometheus metrics endpoint at `https://api.tinybird.co/v0/pipes/organization_metrics.prometheus`.
3939

@@ -61,7 +61,7 @@ scrape_configs:
6161
scrape_interval: 15s # Adjust the scrape interval as needed
6262
scheme: 'https'
6363
static_configs:
64-
- targets:
64+
- targets:
6565
- 'api.tinybird.co' # Adjust this for your region if necessary
6666
metrics_path: '/v0/pipes/organization_metrics.prometheus'
6767
bearer_token: '<admin-user-token>' # From an Organization admin
@@ -128,4 +128,3 @@ Import the dashboard with the following steps:
128128
7. Select **Yes, replace**.
129129

130130
![Datadog dashboard example](./assets/img/datadog.png)
131-

0 commit comments

Comments
 (0)