Skip to content

Commit c3edc03

Browse files
mrbojangles3Frostman
authored andcommitted
chore: warn users about grafana cloud costs and small improvements
Co-authored-by: Sergei Lukianov <[email protected]> Signed-off-by: Logan Blyth <[email protected]> Signed-off-by: Sergei Lukianov <[email protected]>
1 parent acfd5ea commit c3edc03

File tree

2 files changed

+21
-15
lines changed

2 files changed

+21
-15
lines changed

docs/user-guide/.pages

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ nav:
88
- shrink-expand.md
99
- profiles.md
1010
- Observability:
11-
- grafana_config_details.md
11+
- o11y-config.md
1212
- grafana.md
1313
- ...
Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Alloy](https://grafana.com/docs/alloy/latest/) on all switches to forward metric
77
API](https://prometheus.io/docs/specs/prw/remote_write_spec/) and Loki API. Metrics includes port speeds, counters,
88
errors, operational status, transceivers, fans, power supplies, temperature
99
sensors, BGP neighbors, LLDP neighbors, and more. Logs include Hedgehog agent
10-
logs. Modify the URL as needed, instead of `/api/v1/push` it could be
10+
logs, switch syslog, pod logs for all services running in the control node k8s cluster. Modify the URL as needed, instead of `/api/v1/push` it could be
1111
`/api/v1/write`; check the documentation for the data provider.
1212

1313
Switches push telemetry data through a proxy running in a pod on the control
@@ -33,49 +33,55 @@ advisable. For additional details see the
3333
[documentation](https://grafana.com/docs/grafana-cloud/security-and-account-management/authentication-and-permissions/access-policies/)
3434

3535

36-
## Add Credentials to Fabric
36+
## Billing
37+
38+
Users are advised to use the regular expressions to limit the amount of data
39+
sent to grafana cloud as the costs compound quickly.
40+
41+
## Add Credentials
3742

3843
Take the tokens created on grafana cloud and populate them in this YAML file. The username
39-
is different between prometheus and loki. It is suggested
40-
Apply the setting below to the that will allow for telemetry to be pushed to
41-
the specified Grafana instance:
44+
is different between prometheus and loki.
45+
Apply the setting below for telemetry to be pushed to the specified Prometheus and Loki instances:
4246

4347
```{ .yaml .annotate title="credentials.yaml" linenums="1" }
4448
spec:
4549
config:
4650
observability:
51+
labels:
52+
env: hh-fabric # (1)!
4753
targets:
4854
loki:
49-
grafana_cloud: # (1)!
55+
grafana_cloud: # (2)!
5056
basicAuth:
5157
password: "insert_password_or_token_here"
5258
username: "1234567"
5359
labels:
54-
env: hh-fabric # (2)!
60+
some: label # (3)!
5561
url: https://[your-loki-server].grafana.net/loki/api/v1/push
5662
prometheus:
57-
grafana_cloud: # (3)!
63+
grafana_cloud: # (4)!
5864
basicAuth:
5965
password: "insert_password_or_token_here"
6066
username: "1234567"
6167
labels:
62-
env: hh-fabric # (4)!
68+
some: label
6369
url: https://[your-prometheus-server].grafana.net/api/prom/push
6470
6571
```
6672

67-
1. Can be any name of your choosing
68-
2. Value of "env" in dashboard
69-
3. Can be any name of your choosing
70-
4. Value of "env" in dashboard
73+
1. Common label for all targets, "env" is a well-known label used in dashboards
74+
2. Can be any name of your choosing
75+
3. Extra labels applied to a specific target
76+
4. Can be any name of your choosing
7177

7278
To apply these changes to the fabric use the following command:
7379

7480
``` shell
7581
kubectl patch -n fab --type merge fabricator/default --patch-file credentials.yaml
7682
```
7783

78-
## Gateway Observabiltiy
84+
## Gateway Observability
7985

8086
```{ .yaml .annotate title="gateway.yaml" linenums="1" }
8187
spec:

0 commit comments

Comments
 (0)