Skip to content

Update the Integrations doc guidelines to reflect the new template #14917

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.

Sign up for GitHub

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 9 commits into from
Aug 20, 2025
Merged

Update the Integrations doc guidelines to reflect the new template #14917

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2f7ee97
Update doc guidelines
alaudazzi Aug 13, 2025
fe873f2
Update the Overview section
alaudazzi Aug 13, 2025
0367fc0
Update the data-collected section
alaudazzi Aug 13, 2025
430bcc9
Update the requirements section
alaudazzi Aug 13, 2025
f075729
Update the setup section
alaudazzi Aug 13, 2025
99d9c3e
Update the troubleshooting section
alaudazzi Aug 13, 2025
f7a871c
Add the scaling section
alaudazzi Aug 13, 2025
329a3fb
Merge branch 'main' into fix-844
alaudazzi Aug 13, 2025
ed0ca68
Integrate reviewer's comment
alaudazzi Aug 18, 2025
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
268 changes: 48 additions & 220 deletions docs/extend/documentation-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ mapped_pages:

The goal of each integration’s documentation is to:

* Help the reader understand the benefits the integration offers and how Elastic can help with their use case. Inform the reader of any requirements, including system compatibility, supported versions of third-party products, permissions needed, and more.
* Provide a comprehensive list of collected fields and the data and metric types for each. The reader can reference this information while evaluating the integration, interpreting collected data, or troubleshooting issues.
* Set the reader up for a successful installation and setup by connecting them with any other resources they’ll need.
* Each integration document should contain several sections, and you should use consistent headings to make it easier for a single user to evaluate and use multiple integrations.

* [Overview](#idg-docs-guidelines-overview)
* [Datastreams](#idg-docs-guidelines-datastreams)
* [Requirements](#idg-docs-guidelines-requirements)
* [Setup](#idg-docs-guidelines-setup)
* [Troubleshooting (optional)](#idg-docs-guidelines-troubleshooting)
* [Reference](#idg-docs-guidelines-reference)

* Describe the benefits the integration offers and how Elastic can help with different use cases.
* Specify requirements, including system compatibility, supported versions of third-party products, permissions needed, and more.
* Provide a list of collected fields, including data and metric types for each field. This information is useful while evaluating the integration, interpreting collected data, or troubleshooting issues.
* Each integration document should contain the following sections

* [Overview](#idg-docs-overview)
* [What data does this integration collect?](#idg-data-collected)
* [What do I need to use this integration?](#idg-requirements)
* [How do I deploy this integration?](#idg-docs-setup)
* [Troubleshooting](#idg-docs-troubleshooting)
* [Performance and scaling](#idg-docs-performance-scaling)
Copy link
Contributor

@muthu-mps muthu-mps Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The performance and scaling depends on the users underlying infrastructure. Currently, I am noticing the ingest architecture is shared for one of the integrations. Is this an optional section in the document?

Copy link
Contributor Author

@alaudazzi alaudazzi Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, all sections should be included where applicable and if there is relevant content.

* [Reference](#idg-docs-reference)

Some considerations when these documentation files are written at `_dev/build/docs/*.md`:

Expand All @@ -32,245 +32,73 @@ Some considerations when these documentation files are written at `_dev/build/do

* In the documentation files (`_dev/build/docs/*.md`), `{{ url "getting-started-observability" "Elastic guide" }}` generates a link to the Observability Getting Started guide.

### Overview [idg-docs-overview]

The **Overview** section explains what the integration does, what the main uses cases are, and contains the following subsections:

### Overview [idg-docs-guidelines-overview]

The overview section explains what the integration is, defines the third-party product that is providing data, establishes its relationship to the larger ecosystem of Elastic products, and helps the reader understand how it can be used to solve a tangible problem.

The overview should answer the following questions:

* What is the integration?
* What is the third-party product that is providing data?
* What can you do with it?

* General description
* Basic example



#### Template [_template]

Use this template language as a starting point, replacing `<placeholder text>` with details about the integration:

```text
The <name> integration allows you to monitor <service>. <service> is <definition>.

Use the <name> integration to <function>. Then visualize that data in Kibana, create alerts to notify you if something goes wrong, and reference <data stream type> when troubleshooting an issue.

For example, if you wanted to <use case> you could <action>. Then you can <visualize|alert|troubleshoot> by <action>.
```


#### Example [_example]

```text
The AWS CloudFront integration allows you to monitor your AWS CloudFront usage. AWS CloudFront is a content delivery network (CDN) service.

Use the AWS CloudFront integration to collect and parse logs related to content delivery. Then visualize that data in Kibana, create alerts to notify you if something goes wrong, and reference logs when troubleshooting an issue.

For example, you could use the data from this integration to know when there are more than some number of failed requests for a single piece of content in a given time period. You could also use the data to troubleshoot the underlying issue by looking at additional context in the logs like the number of unique users (by IP address) who experienced the issue, the source of the request, and more.
```

* **Compatibility**

### Datastreams [idg-docs-guidelines-datastreams]
Indicates which versions, deployment methods, or architectures of the third party software this integration compatible with.

The data streams section provides a high-level overview of the kind of data that is collected by the integration. This is helpful since it can be difficult to quickly derive an understanding from just the reference sections (since they’re so long).
* **How it works**

The data streams section should include:
Provides a high-level overview on how the integration collects data.

* A list of the types of data streams collected by the integration
* A summary of each type of data stream included and a link to the relevant reference section:
### What data does this integration collect? [idg-data-collected]

* Logs
* Metrics
This section should include:

* Notes (optional)
* The types of data collected by the integration
* Supported use cases

### What do I need to use this integration? [idg-requirements]

#### Template [_template_2]

Use this template language as a starting point, replacing `<placeholder text>` with details about the integration:

```text
## Data streams

The <name> integration collects two types of data streams: logs and metrics.

**Logs** help you keep a record of events happening in <service>.
Log data streams collected by the <name> integration include <select data streams>, and more. See more details in the <Logs reference>.

**Metrics** give you insight into the state of <service>.
Metric data streams collected by the <name> integration include <select data streams> and more. See more details in the [Metrics]<#metrics-reference>.

<!-- etc. -->

<!-- Optional notes -->
```


#### Example [_example_2]

```text
The System integration collects two types of data: logs and metrics.

Logs help you keep a record of events that happen on your machine. Log data streams collected by the System integration include application, system, and security events on machines running Windows or auth and syslog events on machines running macOS or Linux. See more details in the Logs reference.

Metrics give you insight into the state of the machine. Metric data streams collected by the System integration include CPU usage, load statistics, memory usage, information on network behavior, and more. See more details in the Metrics reference.

You can enable and disable individual data streams. If all data streams are disabled and the System integration is still enabled, Fleet uses the default data streams.
```


### Requirements [idg-docs-guidelines-requirements]

The requirements section helps readers to confirm that the integration will work with their systems.
This section indicates what is required to use this integration:

* Elastic prerequisites (for example, a self-managed or Cloud deployment)
* System compatibility
* Supported versions of third-party products
* Permissions needed
* Anything else that could block a user from successfully using the integration


#### Template [_template_3]
* Credentials or an admin account for the third-party software

Use this template language as a starting point, including any other requirements for the integration:
### How do I deploy this integration? [idg-docs-setup]

```text
## Requirements
This section refers to the Observability [Getting started guide](docs-content://solutions/observability/get-started.md) for generic, step-by-step instructions, and should also include the following additional setup instructions:

You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
**Onboard and configure**

<!-- Other requirements -->
```
* How do I install the Agent and deploy this integration?
* Which agent deployment methods are acceptable? Fleet? Standalone?
* Is agentless deployment supported for this integration?
* What data, input, fields, or authentication tokens must be configured during integration deployment? What values should they have?

**Validation**

#### Example [_example_3]

```text
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.

Each data stream collects different kinds of metric data, which may require dedicated permissions to be fetched and may vary across operating systems. Details on the permissions needed for each data stream are available in the Metrics reference.
```

For a much more detailed example, refer to the [AWS integration requirements](https://github.com/elastic/integrations/blob/main/packages/aws/_dev/build/docs/README.md#requirements).


### Setup [idg-docs-guidelines-setup]

The setup section points the reader to the Observability [Getting started guide](docs-content://solutions/observability/get-started.md) for generic, step-by-step instructions.

This section should also include any additional setup instructions beyond what’s included in the guide, which may include instructions to update the configuration of a third-party service. For example, for the Cisco ASA integration, users need to configure their Cisco device following the [steps found in the Cisco documentation](https://documentation.meraki.com/General_Administration/Monitoring_and_Reporting/Syslog_Server_Overview_and_Configuration#Configuring_a_Syslog_Server).
* How can I test whether the integration is working? Include example commands or test files if applicable.

::::{note}
When possible, use links to point to third-party documentation for configuring non-Elastic products since workflows may change without notice.
::::

### Troubleshooting [idg-docs-troubleshooting]

The troubleshooting section should include details specific to each input type, along with general guidance for resolving common issues encountered when deploying this integration. Whenever possible, link to the troubleshooting documentation provided by the third-party software.

#### Template [_template_4]

Use this template language as a starting point, including any other setup instructions for the integration:

```text
## Setup

<!-- Any prerequisite instructions -->

For step-by-step instructions on how to set up an integration, see the
{{ url "getting-started-observability" "Getting started" }} guide.

<!-- Additional set up instructions -->
```


#### Example [_example_4]

```text
Before sending logs to Elastic from your Cisco device, you must configure your device according to <<Cisco's documentation on configuring a syslog server>>.

After you've configured your device, you can set up the Elastic integration. For step-by-step instructions on how to set up an integration, see the <<Getting started>> guide.
```


### Troubleshooting (optional) [idg-docs-guidelines-troubleshooting]

The troubleshooting section is optional. It should contain information about special cases and exceptions that aren’t necessary for getting started or won’t be applicable to all users.
### Performance and scaling [idg-docs-performance-scaling]

Based on the input, this section should explain how to scale the integration and what are the best types of scaling architecture to use, including benchmarking recommendations.

#### Template [_template_5]
### Reference [idg-docs-reference]

There is no standard format for the troubleshooting section.
There can be any number of reference sections, for example:


#### Example [_example_5]

```text
>Note that certain data streams may access `/proc` to gather process information,
>and the resulting `ptrace_may_access()` call by the kernel to check for
>permissions can be blocked by
>[AppArmor and other LSM software](https://gitlab.com/apparmor/apparmor/wikis/TechnicalDoc_Proc_and_ptrace), even though the System module doesn't use `ptrace` directly.
>
>In addition, when running inside a container the proc filesystem directory of the host
>should be set using `system.hostfs` setting to `/hostfs`.
```


### Reference [idg-docs-guidelines-reference]

Readers might use the reference section while evaluating the integration, interpreting collected data, or troubleshooting issues.

There can be any number of reference sections (for example, `## Metrics reference`, `## Logs reference`). Each reference section can contain one or more subsections, such as one for each individual data stream (for example, `### Access Logs` and `### Error logs`).
* ECS Field Reference
* Metrics reference
* Logs reference
* Inputs used in this integration
* APIs used to collect data
* Changelog

Each reference section should contain detailed information about:

* A list of the log or metric types we support within the integration and a link to the relevant third-party documentation.
* A list of the log or metric types supported within the integration and a link to the relevant third-party documentation.
* (Optional) An example event in JSON format.
* Exported fields for logs, metrics, and events with actual types (for example, `counters`, `gauges`, `histograms` vs. `longs` and `doubles`). Fields should be generated using the instructions in [Fine-tune the integration](https://github.com/elastic/integrations/blob/main/docs/fine_tune_integration.md).
* ML Modules jobs.


#### Template [_template_6]

```text
<!-- Repeat for both Logs and Metrics if applicable -->
## <Logs|Metrics> reference

<!-- Repeat for each data stream of the current type -->
## <Data stream name>

The `<data stream name>` data stream provides events from <source> of the following types: <list types>.

<!-- Optional -->
<!-- #### Example -->
<!-- An example event for `<data stream name>` looks as following: -->
<!-- <code block with example> -->

### Exported fields

<insert table>
```


#### Example [_example_6]

```text
>## Logs reference
>
>### PAN-OS
>
>The `panos` data stream provides events from Palo Alto Networks device of the following types: [GlobalProtect](https://docs.paloaltonetworks.com/pan-os/10-2/pan-os-admin/monitoring/use-syslog-for-monitoring/syslog-field-descriptions/globalprotect-log-fields), [HIP Match](https://docs.paloaltonetworks.com/pan-os/10-2/pan-os-admin/monitoring/use-syslog-for-monitoring/syslog-field-descriptions/hip-match-log-fields), [Threat](https://docs.paloaltonetworks.com/pan-os/10-2/pan-os-admin/monitoring/use-syslog-for-monitoring/syslog-field-descriptions/threat-log-fields), [Traffic](https://docs.paloaltonetworks.com/pan-os/10-2/pan-os-admin/monitoring/use-syslog-for-monitoring/syslog-field-descriptions/traffic-log-fields) and [User-ID](https://docs.paloaltonetworks.com/pan-os/10-2/pan-os-admin/monitoring/use-syslog-for-monitoring/syslog-field-descriptions/user-id-log-fields).
>
>#### Example
>
>An example event for `panos` looks as following:
>
>(code block)
>
>#### Exported fields
>
>(table of fields)
```

* ML Modules jobs.
Loading