Skip to content

Commit ddbcc1c

Browse files
authored
docs(review): cpt weekly review (#4147)
1 parent ee1b160 commit ddbcc1c

10 files changed

+24
-72
lines changed

observability/cockpit/concepts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Explore Scaleway Observability concepts including metrics, logs, and alerts management through Cockpit. Learn about agents, alerting rules, Grafana integration, and data types for comprehensive monitoring.
88
tags: observability alert-manager contact-points endpoint grafana loki logql prometheus promql tokens
99
dates:
10-
validation: 2024-06-19
10+
validation: 2024-12-26
1111
categories:
1212
- observability
1313
---

observability/cockpit/how-to/access-grafana-and-managed-dashboards.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,14 @@ tags: observability cockpit grafana managed-dashboard
99
categories:
1010
- observability
1111
dates:
12-
validation: 2024-06-19
12+
validation: 2024-12-26
1313
posted: 2022-10-31
1414
---
1515

1616
Scaleway provides you with managed dashboards you can access in Grafana, for [Scaleway resources integrated with Cockpit](/observability/cockpit/reference-content/cockpit-limitations/#product-integration-into-cockpit).
1717

1818
This page shows you how to access [managed dashboards](/observability/cockpit/concepts/#managed-dashboards).
1919

20-
<Macro id="cockpit-update-dashboards" />
21-
2220
<Macro id="requirements" />
2321

2422
- A Scaleway account logged into the [console](https://console.scaleway.com)
@@ -30,7 +28,7 @@ This page shows you how to access [managed dashboards](/observability/cockpit/co
3028
2. Click **Open dashboards** to open your managed dashboards in Grafana. You are redirected to the Grafana website.
3129
3. Enter your [Grafana credentials](/observability/cockpit/how-to/retrieve-grafana-credentials/).
3230
4. Click **Log in**. The Grafana overview page displays.
33-
5. Click the **Home** icon.
31+
5. Click the **Home** icon at the top left of your screen.
3432
6. Click **Dashboard**. The Scaleway folder appears, with a list of all available managed dashboards for Scaleway resources.
3533
7. Click the dashboard you want to view.
3634

observability/cockpit/how-to/activate-push-traces.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ content:
88
categories:
99
- observability cockpit traces push
1010
dates:
11-
validation: 2024-06-19
11+
validation: 2024-12-26
1212
posted: 2023-10-31
1313
---
1414

@@ -23,7 +23,7 @@ This page shows you how to create [traces](/observability/cockpit/concepts/#trac
2323

2424
1. Click **Cockpit** in the Observability section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
2525
2. Click the **Data sources** tab.
26-
3. Click **+ Create custom data sources**. A pop-up displays.
26+
3. Click **+ Create custom data source**. A pop-up displays.
2727
4. Complete the required steps to create your trace:
2828
- Enter a name
2929
- Choose the **Traces** data type
@@ -44,7 +44,7 @@ Alternatively, you can retrieve your trace's push path from the Scaleway console
4444
1. Click **Cockpit** in the Observability section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
4545
2. Click the **Data sources** tab.
4646
3. Click the trace of which you want to retrieve the path. The trace's information displays.
47-
4. Retrieve the push path under the **Push path** section.
47+
4. Retrieve the push path under the **URL** section.
4848

4949
## Push traces
5050

observability/cockpit/how-to/add-contact-points.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ content:
88
categories:
99
- observability
1010
dates:
11-
validation: 2024-06-19
11+
validation: 2024-12-26
1212
posted: 2024-04-05
1313
---
1414

@@ -24,7 +24,7 @@ This page shows you how to associate [contact points](/observability/cockpit/con
2424

2525
1. Click **Cockpit** in the Observability section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
2626
2. Click the **Alerts** tab.
27-
3. Click **Add an email** in the **Default receiver’s contact points** section. A pop-up displays.
27+
3. Click **+ Add email** in the **Default receiver’s contact points** section. A pop-up displays.
2828
4. Enter the email address you wish to add as a contact point.
2929
5. Choose the regions in which you want to add the contact point.
3030
<Message type="important">

observability/cockpit/how-to/create-token.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags: cockpit observability token
99
categories:
1010
- observability
1111
dates:
12-
validation: 2024-06-19
12+
validation: 2024-12-26
1313
posted: 2022-10-31
1414
---
1515

@@ -22,8 +22,8 @@ This page shows you how to create [tokens](/observability/cockpit/concepts/#toke
2222

2323
1. Click **Cockpit** in the Observability section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
2424
2. Click the **Tokens** tab.
25-
3. Click **Create token**. A pop-up displays prompting you to create a token.
26-
4. Choose the region to create the token in.
25+
3. Click **+ Create token**. A pop-up displays.
26+
4. Choose a region to create the token in.
2727
<Message type="important">
2828
Make sure that you create your token in the same region as the [data sources](/observability/cockpit/concepts/#data-sources) you want to use it for.
2929
</Message>

observability/cockpit/how-to/retrieve-grafana-credentials.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags: cockpit observability grafana credentials
99
categories:
1010
- observability
1111
dates:
12-
validation: 2024-06-19
12+
validation: 2024-12-26
1313
posted: 2022-10-31
1414
---
1515

@@ -23,7 +23,7 @@ This page shows you how to retrieve your Grafana credentials to access your Graf
2323

2424
1. Click **Cockpit** in the Observability section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
2525
2. Click the **Grafana users** tab.
26-
3. Click **Add user**.
26+
3. Click **+ Add user**.
2727
4. Enter a username.
2828
5. Select a [role](/observability/cockpit/concepts/#grafana-users) for the user.
2929
6. Click **Add user**. Your automatically generated password to log in to Grafana displays. Make sure to copy and save it before closing the pop-up.

observability/cockpit/how-to/send-metrics-logs-to-cockpit.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ tags: metrics cockpit logs observability
99
categories:
1010
- observability
1111
dates:
12-
validation: 2024-06-19
12+
validation: 2024-12-26
1313
posted: 2022-10-31
1414
---
1515

16-
This page shows you how to send [metrics](/observability/cockpit/concepts/#metric) and [logs](/observability/cockpit/concepts/#logs) to your [Cockpit](/observability/cockpit/concepts/#cockpit). You can push metrics with any `Prometheus Remote Write` compatible agent such as the [Prometheus](https://prometheus.io/docs/introduction/overview/), [Grafana](https://grafana.com/docs/agent/latest/) or [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) agents.
16+
This page shows you how to send data such as [metrics](/observability/cockpit/concepts/#metric) and [logs](/observability/cockpit/concepts/#logs) to your [Cockpit](/observability/cockpit/concepts/#cockpit). You can push metrics with any `Prometheus Remote Write` compatible agent such as the [Prometheus](https://prometheus.io/docs/introduction/overview/), [Grafana](https://grafana.com/docs/agent/latest/) or [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) agents.
1717
You can push logs with any Loki compatible agent such as the [Promtail](https://grafana.com/docs/loki/latest/clients/promtail/), [Fluentd](https://docs.fluentd.org/), [Fluent Bit](https://docs.fluentbit.io/manual/) or [Logstash](https://www.elastic.co/guide/en/logstash/current/introduction.html) agents.
1818

1919
<Macro id="requirements" />

observability/cockpit/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Discover how to begin with the Scaleway Observability Cockpit. Learn to set up Grafana credentials, create push tokens, and leverage Grafana agents for monitoring metrics, logs, and traces.
88
tags: observability cockpit
99
dates:
10-
validation: 2024-06-19
10+
validation: 2024-12-26
1111
posted: 2022-10-31
1212
categories:
1313
- observability

observability/cockpit/troubleshooting/pusher-does-not-support-custom-http-headers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Discover solutions to handle pushers that do not support custom HTTP headers.
88
tags: pusher token header
99
dates:
10-
validation: 2024-06-19
10+
validation: 2024-12-26
1111
posted: 2023-04-03
1212
categories:
1313
- observability

observability/cockpit/troubleshooting/resetting-grafana-password-via-the-api.mdx

Lines changed: 7 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ meta:
66
paragraph: Reset your Grafana user password using the Scaleway API. Retrieve your Grafana user ID and reset the password with a simple curl command.
77
tags: grafana password credentials
88
dates:
9-
validation: 2024-06-19
9+
validation: 2024-12-26
1010
posted: 2023-04-03
1111
categories:
1212
- observability
1313
---
1414

15-
This page shows you how to reset your Grafana user's password through the Scaleway API.
15+
This page shows you how to reset your Grafana user's password through the Scaleway console.
1616

1717
<Macro id="requirements" />
1818

@@ -21,54 +21,8 @@ This page shows you how to reset your Grafana user's password through the Scalew
2121
- [Installed](https://curl.se/download.html) curl
2222

2323

24-
Open a terminal and paste the following command to retrieve your Grafana user ID:
25-
26-
```
27-
curl --request GET \
28-
--url 'http://api.scaleway.com/cockpit/v1beta1/grafana-users?project_id=<SCW_PROJECT_ID>' \
29-
--header 'X-Auth-Token: $SCW_SECRET_KEY'
30-
```
31-
32-
An output with a list of all Grafana users associated with your Cockpit and their IDs should display:
33-
34-
```
35-
{
36-
"total_count": 3,
37-
"grafana_users": [
38-
{
39-
"id": 74,
40-
"login": "user1",
41-
"role": "editor",
42-
"password": ""
43-
},
44-
{
45-
"id": 8,
46-
"login": "user2",
47-
"role": "editor",
48-
"password": ""
49-
},
50-
{
51-
"id": 41,
52-
"login": "user3",
53-
"role": "editor",
54-
"password": ""
55-
}
56-
]
57-
}
58-
```
59-
60-
Paste the following command to reset the password of the desired Grafana user. Make sure that you replace `{grafana_user_id}` with the ID of the relevant Grafana user.
61-
62-
```bash
63-
curl -X POST \
64-
-H "X-Auth-Token: $SCW_SECRET_KEY" \
65-
-H "Content-Type: application/json" \
66-
-d '{"project_id":"string"}' \
67-
"https://api.scaleway.com/cockpit/v1beta1/grafana-users/{grafana_user_id}/reset-password"
68-
```
69-
70-
The output displays a new password for your Grafana user.
71-
72-
<Message type="important">
73-
You can also reset a Grafana user's password from the **Grafana users** tab of the [Scaleway console](https://console.scaleway.com/cockpit/users) > Click the <Icon name="more" /> icon next to the relevant Grafana user > Click **Generate password** > **Generate new password**.
74-
</Message>
24+
1. Click **Cockpit** in the Observability section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
25+
2. Click the **Grafana users** tab.
26+
3. Click the <Icon name="more" /> icon next to the relevant Grafana user.
27+
4. Click **Generate password**.
28+
5. Click **Generate new password** to confirm. Your new password displays. Make sure that you copy it before leaving the page.

0 commit comments

Comments
 (0)