Skip to content

Commit 18379cc

Browse files
author
jdv
committed
side bar renamming + mini uniformization
1 parent b15fae2 commit 18379cc

File tree

3 files changed

+40
-80
lines changed

3 files changed

+40
-80
lines changed

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.js

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -352,8 +352,16 @@ module.exports = {
352352
id: "contributing/contributing_bouncers",
353353
},
354354
items: [
355-
"contributing/specs/bouncer_appsec_specs",
356-
"contributing/specs/bouncer_metrics_specs",
355+
{
356+
type: "doc",
357+
id: "contributing/specs/bouncer_appsec_specs",
358+
label: "Bouncer&AppSec",
359+
},
360+
{
361+
type: "doc",
362+
id: "contributing/specs/bouncer_metrics_specs",
363+
label: "Metrics",
364+
},
357365
]
358366
},
359367
"contributing/contributing_test_env",

0 commit comments

Comments
 (0)