|
| 1 | +# Agent Check: BentoML |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +This check monitors [BentoML][1] through the Datadog Agent. |
| 6 | + |
| 7 | +Include a high level overview of what this integration does: |
| 8 | +- What does your product do (in 1-2 sentences)? |
| 9 | +- What value will customers get from this integration, and why is it valuable to them? |
| 10 | +- What specific data will your integration monitor, and what's the value of that data? |
| 11 | + |
| 12 | +## Setup |
| 13 | + |
| 14 | +Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the [Autodiscovery Integration Templates][3] for guidance on applying these instructions. |
| 15 | + |
| 16 | +### Installation |
| 17 | + |
| 18 | +The BentoML check is included in the [Datadog Agent][2] package. |
| 19 | +No additional installation is needed on your server. |
| 20 | + |
| 21 | +### Configuration |
| 22 | + |
| 23 | +1. Edit the `bentoml.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your bentoml performance data. See the [sample bentoml.d/conf.yaml][4] for all available configuration options. |
| 24 | + |
| 25 | +2. [Restart the Agent][5]. |
| 26 | + |
| 27 | +### Validation |
| 28 | + |
| 29 | +[Run the Agent's status subcommand][6] and look for `bentoml` under the Checks section. |
| 30 | + |
| 31 | +## Data Collected |
| 32 | + |
| 33 | +### Metrics |
| 34 | + |
| 35 | +See [metadata.csv][7] for a list of metrics provided by this integration. |
| 36 | + |
| 37 | +### Events |
| 38 | + |
| 39 | +The BentoML integration does not include any events. |
| 40 | + |
| 41 | +### Service Checks |
| 42 | + |
| 43 | +The BentoML integration does not include any service checks. |
| 44 | + |
| 45 | +See [service_checks.json][8] for a list of service checks provided by this integration. |
| 46 | + |
| 47 | +## Troubleshooting |
| 48 | + |
| 49 | +Need help? Contact [Datadog support][9]. |
| 50 | + |
| 51 | + |
| 52 | +[1]: **LINK_TO_INTEGRATION_SITE** |
| 53 | +[2]: https://app.datadoghq.com/account/settings/agent/latest |
| 54 | +[3]: https://docs.datadoghq.com/containers/kubernetes/integrations/ |
| 55 | +[4]: https://github.com/DataDog/integrations-core/blob/master/bentoml/datadog_checks/bentoml/data/conf.yaml.example |
| 56 | +[5]: https://docs.datadoghq.com/agent/configuration/agent-commands/#start-stop-and-restart-the-agent |
| 57 | +[6]: https://docs.datadoghq.com/agent/configuration/agent-commands/#agent-status-and-information |
| 58 | +[7]: https://github.com/DataDog/integrations-core/blob/master/bentoml/metadata.csv |
| 59 | +[8]: https://github.com/DataDog/integrations-core/blob/master/bentoml/assets/service_checks.json |
| 60 | +[9]: https://docs.datadoghq.com/help/ |
0 commit comments