Skip to content

Commit 1ef17b0

Browse files
authored
Add integration documentation template (#1575)
1 parent 0d4d99d commit 1ef17b0

File tree

1 file changed

+104
-0
lines changed

1 file changed

+104
-0
lines changed
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
date: YYYY-MM-DD
3+
id: [service-name]
4+
title: AWS [Service Name] Integration
5+
---
6+
7+
{/* Keep the file name same as the id */}
8+
9+
This integration enables seamless monitoring of your AWS [Service Name] infrastructure by collecting comprehensive metrics and logs from your [service specific resources]. With SigNoz's one-click AWS integration, you can start monitoring your [Service Name] environment in minutes without complex manual configurations.
10+
11+
AWS [Service Name] is [brief description of the service]. Monitoring [Service Name] is crucial for [specific monitoring benefits like performance optimization, cost management, troubleshooting issues, and capacity planning].
12+
13+
<figure data-zoomable align='center'>
14+
<img className="box-shadowed-image" src="/img/docs/integrations/one-click-aws/[service-name]/[service-name]-integration-overview.webp" alt="[Service Name] Integration Overview in SigNoz"/>
15+
<figcaption><i>Monitor [Service Name] with SigNoz</i></figcaption>
16+
</figure>
17+
18+
## What You'll Monitor & Data Collected
19+
20+
This integration collects comprehensive [Service Name] metrics and logs, providing visibility into:
21+
22+
### Core [Service Name] Metrics
23+
- **[Metric Category 1]**: [Description of what this tracks]
24+
- **[Metric Category 2]**: [Description of what this tracks]
25+
- **[Metric Category 3]**: [Description of what this tracks]
26+
- **[Metric Category 4]**: [Description of what this tracks]
27+
- **[Metric Category 5]**: [Description of what this tracks]
28+
29+
### [Enhanced Feature] Metrics (when enabled)
30+
When AWS [Enhanced Feature] is enabled for your [Service Name] resources, this integration also collects enhanced metrics including:
31+
- **[Enhanced metric type 1]**
32+
- **[Enhanced metric type 2]**
33+
- **[Enhanced metric type 3]**
34+
- **[Enhanced metric type 4]**
35+
36+
### [Service Name] Logs
37+
- **[Log type 1]**: [Description of log type]
38+
- **[Log type 2]**: [Description of log type]
39+
- **[Log type 3]**: [Description of log type]
40+
41+
### Collected Data Details
42+
43+
<details>
44+
<summary>📋 Logs List</summary>
45+
46+
| Name | Path | Type |
47+
|------|------|------|
48+
| [Log Field 1] | [path.to.field1] | [data type] |
49+
| [Log Field 2] | [path.to.field2] | [data type] |
50+
| [Log Field 3] | [path.to.field3] | [data type] |
51+
52+
</details>
53+
54+
<details>
55+
<summary>📊 Metrics List</summary>
56+
57+
| Metric Name | Unit | Type |
58+
|-------------|------|------|
59+
| aws_[SERVICE]_[MetricName]_count | [Unit] | Gauge |
60+
| aws_[SERVICE]_[MetricName]_max | [Unit] | Gauge |
61+
| aws_[SERVICE]_[MetricName]_min | [Unit] | Gauge |
62+
| aws_[SERVICE]_[MetricName]_sum | [Unit] | Gauge |
63+
| aws_[SERVICE]_[EnhancedMetric]_count | [Unit] | Gauge |
64+
| aws_[SERVICE]_[EnhancedMetric]_max | [Unit] | Gauge |
65+
| aws_[SERVICE]_[EnhancedMetric]_min | [Unit] | Gauge |
66+
| aws_[SERVICE]_[EnhancedMetric]_sum | [Unit] | Gauge |
67+
68+
</details>
69+
70+
## Dashboards
71+
72+
### AWS [Service Name] Overview Dashboard
73+
74+
The integration provides a comprehensive overview dashboard with key [Service Name] metrics:
75+
76+
<figure data-zoomable align='center'>
77+
<img className="box-shadowed-image" src="/img/docs/integrations/one-click-aws/[service-name]/[service-name]-overview-dashboard.webp" alt="AWS [Service Name] Overview Dashboard"/>
78+
<figcaption><i>AWS [Service Name] Overview Dashboard</i></figcaption>
79+
</figure>
80+
81+
**Key visualizations include:**
82+
- **[Visualization 1]**: [Description of what it shows]
83+
- **[Visualization 2]**: [Description of what it shows]
84+
85+
### [Service Name] [Enhanced Feature] Dashboard
86+
87+
For enhanced monitoring with [Enhanced Feature] enabled:
88+
89+
<figure data-zoomable align='center'>
90+
<img className="box-shadowed-image" src="/img/docs/integrations/one-click-aws/[service-name]/[service-name]-[enhanced-feature].webp" alt="[Service Name] [Enhanced Feature] Dashboard"/>
91+
<figcaption><i>[Service Name] [Enhanced Feature] Dashboard</i></figcaption>
92+
</figure>
93+
94+
**Key visualizations include:**
95+
- **[Enhanced Visualization 1]**: [Description]
96+
- **[Enhanced Visualization 2]**: [Description]
97+
- **[Enhanced Visualization 3]**: [Description]
98+
- **[Enhanced Visualization 4]**: [Description]
99+
- **[Enhanced Visualization 5]**: [Description]
100+
- **[Enhanced Visualization 6]**: [Description]
101+
102+
---
103+
104+
Ready to explore more integrations? [Browse all available integrations](https://signoz.io/docs/integrations/integrations-list/)

0 commit comments

Comments
 (0)