> For the complete documentation index, see [llms.txt](https://docs.akamas.io/akamas-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.akamas.io/akamas-docs/3.3.1/akamas-reference/construct-templates/telemetry-providers-template.md).

# Telemetry Provider template

Telemetry Providers are defined using a YAML manifest with the following structure:

```yaml
name: "<string>"
description: "<string>"
dockerImage: "<string>"
```

with the following properties:

| Name          | Type   | Description                                                                                                                                                              | Mandatory |
| ------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- |
| `name`        | string | The name of the Telemetry Provider. This name will be used to reference the Telemetry Provider in the Telemetry Provider Instances. This is unique in an Akamas instance | yes       |
| `description` | string | A description for the Telemetry Provider                                                                                                                                 | yes       |
| `dockerImage` | string | The docker image of the Telemetry Provider.                                                                                                                              | yes       |

Refer to the page [Integrating Telemetry Providers](/akamas-docs/3.3.1/integrating-akamas/integrating-telemetry-providers.md) which describes the out-of-the-box Telemetry Providers that are created automatically at Akamas install time.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.akamas.io/akamas-docs/3.3.1/akamas-reference/construct-templates/telemetry-providers-template.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.