Skip to content

Commit af2432e

Browse files
author
jdv
committed
side bar renamming + mini uniformization
1 parent 1e2bee5 commit af2432e

3 files changed

Lines changed: 40 additions & 80 deletions

File tree

crowdsec-docs/docs/contributing/specs/bouncer_appsec_specs.mdx

Lines changed: 29 additions & 74 deletions
Large diffs are not rendered by default.

crowdsec-docs/docs/contributing/specs/bouncer_metrics_specs.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
---
22
id: bouncer_metrics_specs
33
title: Remediation Component Metrics
4-
sidebar_position: 5
54
---
65

7-
# Remediation Metrics Implementation Guide
8-
96
## Overview
107

118
This document provides a comprehensive guide for developers to implement the "[Remediation Metrics](https://docs.crowdsec.net/docs/next/observability/usage_metrics)" feature in a remediation component. The remediation metrics feature allows remediation components to report [raw metrics](https://docs.crowdsec.net/u/service_api/quickstart/metrics/#raw-metrics) about their activity to the Local API (LAPI), which can then be forwarded to the Central API (CAPI) for monitoring and analytics purposes.
@@ -331,7 +328,7 @@ function pushUsageMetrics(bouncerName: string, bouncerVersion: string, bouncerTy
331328
return metricsPayload
332329
```
333330

334-
## Integration Points
331+
## Useful Tips
335332

336333
### When to Update Metrics
337334

crowdsec-docs/sidebars.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,16 @@ const sidebarsConfig: SidebarConfig = {
288288
id: "contributing/contributing_bouncers",
289289
},
290290
items: [
291-
"contributing/specs/bouncer_appsec_specs",
292-
"contributing/specs/bouncer_metrics_specs",
291+
{
292+
type: "doc",
293+
id: "contributing/specs/bouncer_appsec_specs",
294+
label: "Bouncer&AppSec",
295+
},
296+
{
297+
type: "doc",
298+
id: "contributing/specs/bouncer_metrics_specs",
299+
label: "Metrics",
300+
},
293301
]
294302
},
295303
"contributing/contributing_test_env",

0 commit comments

Comments
 (0)