Skip to content

Add integration documentation template #1575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 8, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions data/docs/integrations/aws/integration-template.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
---
date: YYYY-MM-DD
id: [service-name]
title: AWS [Service Name] Integration
---

{/* Keep the file name same as the id */}

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.

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

<figure data-zoomable align='center'>
<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"/>
<figcaption><i>Monitor [Service Name] with SigNoz</i></figcaption>
</figure>

## What You'll Monitor & Data Collected

This integration collects comprehensive [Service Name] metrics and logs, providing visibility into:

### Core [Service Name] Metrics
- **[Metric Category 1]**: [Description of what this tracks]
- **[Metric Category 2]**: [Description of what this tracks]
- **[Metric Category 3]**: [Description of what this tracks]
- **[Metric Category 4]**: [Description of what this tracks]
- **[Metric Category 5]**: [Description of what this tracks]

### [Enhanced Feature] Metrics (when enabled)
When AWS [Enhanced Feature] is enabled for your [Service Name] resources, this integration also collects enhanced metrics including:
- **[Enhanced metric type 1]**
- **[Enhanced metric type 2]**
- **[Enhanced metric type 3]**
- **[Enhanced metric type 4]**

### [Service Name] Logs
- **[Log type 1]**: [Description of log type]
- **[Log type 2]**: [Description of log type]
- **[Log type 3]**: [Description of log type]

### Collected Data Details

<details>
<summary>📋 Logs List</summary>

| Name | Path | Type |
|------|------|------|
| [Log Field 1] | [path.to.field1] | [data type] |
| [Log Field 2] | [path.to.field2] | [data type] |
| [Log Field 3] | [path.to.field3] | [data type] |

</details>

<details>
<summary>📊 Metrics List</summary>

| Metric Name | Unit | Type |
|-------------|------|------|
| aws_[SERVICE]_[MetricName]_count | [Unit] | Gauge |
| aws_[SERVICE]_[MetricName]_max | [Unit] | Gauge |
| aws_[SERVICE]_[MetricName]_min | [Unit] | Gauge |
| aws_[SERVICE]_[MetricName]_sum | [Unit] | Gauge |
| aws_[SERVICE]_[EnhancedMetric]_count | [Unit] | Gauge |
| aws_[SERVICE]_[EnhancedMetric]_max | [Unit] | Gauge |
| aws_[SERVICE]_[EnhancedMetric]_min | [Unit] | Gauge |
| aws_[SERVICE]_[EnhancedMetric]_sum | [Unit] | Gauge |

</details>

## Dashboards

### AWS [Service Name] Overview Dashboard

The integration provides a comprehensive overview dashboard with key [Service Name] metrics:

<figure data-zoomable align='center'>
<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"/>
<figcaption><i>AWS [Service Name] Overview Dashboard</i></figcaption>
</figure>

**Key visualizations include:**
- **[Visualization 1]**: [Description of what it shows]
- **[Visualization 2]**: [Description of what it shows]

### [Service Name] [Enhanced Feature] Dashboard

For enhanced monitoring with [Enhanced Feature] enabled:

<figure data-zoomable align='center'>
<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"/>
<figcaption><i>[Service Name] [Enhanced Feature] Dashboard</i></figcaption>
</figure>

**Key visualizations include:**
- **[Enhanced Visualization 1]**: [Description]
- **[Enhanced Visualization 2]**: [Description]
- **[Enhanced Visualization 3]**: [Description]
- **[Enhanced Visualization 4]**: [Description]
- **[Enhanced Visualization 5]**: [Description]
- **[Enhanced Visualization 6]**: [Description]

---

Ready to explore more integrations? [Browse all available integrations](https://signoz.io/docs/integrations/integrations-list/)