Docs and metric descriptions for BentoML (DataDog#21580)

* changelog updates

* readme

* log collection readme

* metric descriptions

* Update bentoml/README.md

Co-authored-by: Alicia Thuerk <26307719+git-thuerk-done@users.noreply.github.com>

* Update bentoml/README.md

Co-authored-by: Alicia Thuerk <26307719+git-thuerk-done@users.noreply.github.com>

* Update bentoml/README.md

Co-authored-by: Alicia Thuerk <26307719+git-thuerk-done@users.noreply.github.com>

* Update bentoml/README.md

Co-authored-by: Alicia Thuerk <26307719+git-thuerk-done@users.noreply.github.com>

* Update bentoml/README.md

Co-authored-by: Alicia Thuerk <26307719+git-thuerk-done@users.noreply.github.com>

* Update bentoml/README.md

Co-authored-by: Alicia Thuerk <26307719+git-thuerk-done@users.noreply.github.com>

* Update bentoml/README.md

Co-authored-by: Alicia Thuerk <26307719+git-thuerk-done@users.noreply.github.com>

* hatch env update

* small edit

* Update bentoml/README.md

Co-authored-by: Sarah Witt <sarah.witt@datadoghq.com>

* nit

* validation

* changelog

---------

Co-authored-by: Alicia Thuerk <26307719+git-thuerk-done@users.noreply.github.com>
Co-authored-by: Sarah Witt <sarah.witt@datadoghq.com>

Author: 3 people

bentoml/README.md

@@ -2,12 +2,11 @@
 
 ## Overview
 
-This check monitors [BentoML][1] through the Datadog Agent. 
+This check monitors [BentoML][1] through the Datadog Agent.
 
-Include a high level overview of what this integration does:
-- What does your product do (in 1-2 sentences)?
-- What value will customers get from this integration, and why is it valuable to them?
-- What specific data will your integration monitor, and what's the value of that data?
+BentoML is an open-source platform for building, shipping, and running machine learning models in production. This integration enables you to track the health and performance of your BentoML model serving infrastructure directly from Datadog.
+
+By using this integration, you gain visibility into key BentoML metrics such as request throughput, response latency, error rates, and resource utilization. Monitoring these metrics helps you ensure reliable model deployments, quickly detect issues, and optimize the performance of your ML services in production environments.
 
 **Minimum Agent version:** 7.70.1
 
@@ -17,15 +16,65 @@ Follow the instructions below to install and configure this check for an Agent r
 
 ### Installation
 
-The BentoML check is included in the [Datadog Agent][2] package.
-No additional installation is needed on your server.
+Starting with Agent version `7.71.0`, the BentoML check is included in the [Datadog Agent][2] package. No additional installation is needed on your environment. 
 
 ### Configuration
 
-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.
+#### Metrics
+
+The BentoML integration collects data from both the [health API endpoints][11] and the [Prometheus metrics endpoint][10]. By default, BentoML exposes these endpoints, so in most cases, no additional configuration is required on the BentoML side. For more information about these endpoints and how to enable or secure them, refer to the [BentoML observability documentation][11].
+
+To configure the Datadog Agent to collect BentoML metrics:
+
+1. Edit the `bentoml.d/conf.yaml` file, located in the `conf.d/` directory at the root of your Agent's configuration folder. This file controls how the Agent collects metrics from your BentoML deployment. For a full list of configuration options, see the [sample bentoml.d/conf.yaml][4]. Below is a minimal example configuration:
+
+```yaml
+init_config:
+instances:
+  - openmetrics_endpoint: http://localhost:3000/metrics
+    tags:
+    - bentoml_service: foo # Tag to easily scope metrics
+```
 
 2. [Restart the Agent][5].
 
+#### Logs
+
+BentoML logs can be collected by the Datadog Agent using several methods:
+
+- **Agent log collection (recommended)**: Configure the Datadog Agent to tail BentoML log files. See the [BentoML documentation][12] for more details.
+
+**For host-based Agents:**
+
+1. Enable log collection in your `datadog.yaml` file (disabled by default):
+
+    ```yaml
+    logs_enabled: true
+    ```
+
+2. Configure the Agent to tail BentoML logs by editing `bentoml.d/conf.yaml` (or the corresponding file in `conf.d/`):
+
+    ```yaml
+    logs:
+      - type: file
+        path: monitoring/text_summarization/data/*.log
+        source: bentoml
+        service: <SERVICE>
+    ```
+
+   Replace `<SERVICE>` with a name that matches your service.
+
+**For containerized environments**:
+
+- Ensure the BentoML log files are mounted inside the Datadog Agent container so they can be accessed and tailed. See [container based log collection][14] for more information.
+
+**Other log shipping options**:
+
+- **Fluent Bit**: Forward logs to Datadog using [Fluent Bit][13].
+- **OTLP**: Send logs to the Datadog Agent using the [OpenTelemetry Protocol (OTLP)][14].
+
+Choose the log collection method that best fits your environment and operational needs. Ensure the logs are tagged correctly with `source:bentoml`.
+
 ### Validation
 
 [Run the Agent's status subcommand][6] and look for `bentoml` under the Checks section.
@@ -42,16 +91,14 @@ The BentoML integration does not include any events.
 
 ### Service Checks
 
-The BentoML integration does not include any service checks.
-
 See [service_checks.json][8] for a list of service checks provided by this integration.
 
 ## Troubleshooting
 
 Need help? Contact [Datadog support][9].
 
 
-[1]: **LINK_TO_INTEGRATION_SITE**
+[1]: https://docs.bentoml.com/en/latest/index.html
 [2]: https://app.datadoghq.com/account/settings/agent/latest
 [3]: https://docs.datadoghq.com/containers/kubernetes/integrations/
 [4]: https://github.com/DataDog/integrations-core/blob/master/bentoml/datadog_checks/bentoml/data/conf.yaml.example
@@ -60,3 +107,8 @@ Need help? Contact [Datadog support][9].
 [7]: https://github.com/DataDog/integrations-core/blob/master/bentoml/metadata.csv
 [8]: https://github.com/DataDog/integrations-core/blob/master/bentoml/assets/service_checks.json
 [9]: https://docs.datadoghq.com/help/
+[10]: https://docs.bentoml.com/en/latest/build-with-bentoml/observability/metrics.html
+[11]: https://docs.bentoml.com/en/latest/build-with-bentoml/observability/monitoring-and-data-collection.html#monitoring
+[12]: https://docs.bentoml.com/en/latest/build-with-bentoml/observability/monitoring-and-data-collection.html#view-request-and-schema-logs
+[13]: https://docs.fluentbit.io/manual/data-pipeline/outputs/datadog
+[14]: https://docs.datadoghq.com/opentelemetry/setup/otlp_ingest_in_the_agent/?tab=docker#enabling-otlp-ingestion-on-the-datadog-agent

bentoml/assets/configuration/spec.yaml

@@ -13,3 +13,9 @@ files:
         openmetrics_endpoint.description: |
           Endpoint exposing the BentoML Prometheus metrics. For more information refer to:
           https://docs.bentoml.com/en/latest/build-with-bentoml/observability/metrics.html
+  - template: logs
+    example:
+    - type: file
+      path: monitoring/text_summarization/data/*.log
+      source: bentoml
+      service: <SERVICE>

bentoml/changelog.d/21580.added

@@ -0,0 +1 @@
+Add log config section

bentoml/datadog_checks/bentoml/data/conf.yaml.example

@@ -640,3 +640,24 @@ instances:
     #   - <INCLUDE_REGEX>
     #   exclude:
     #   - <EXCLUDE_REGEX>
+
+## Log Section
+##
+## type - required - Type of log input source (tcp / udp / file / windows_event).
+## port / path / channel_path - required - Set port if type is tcp or udp.
+##                                         Set path if type is file.
+##                                         Set channel_path if type is windows_event.
+## source  - required - Attribute that defines which integration sent the logs.
+## encoding - optional - For file specifies the file encoding. Default is utf-8. Other
+##                       possible values are utf-16-le and utf-16-be.
+## service - optional - The name of the service that generates the log.
+##                      Overrides any `service` defined in the `init_config` section.
+## tags - optional - Add tags to the collected logs.
+##
+## Discover Datadog log collection: https://docs.datadoghq.com/logs/log_collection/
+#
+# logs:
+#   - type: file
+#     path: monitoring/text_summarization/data/*.log
+#     source: bentoml
+#     service: <SERVICE>

bentoml/metadata.csv

@@ -1,12 +1,12 @@
 metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name,curated_metric,sample_tags
-bentoml.endpoint_livez,gauge,,,,,0,bentoml,,,
-bentoml.endpoint_readyz,gauge,,,,,0,bentoml,,,
-bentoml.service.adaptive_batch_size.bucket,count,,,,,0,bentoml,,,
-bentoml.service.adaptive_batch_size.count,count,,,,,0,bentoml,,,
-bentoml.service.adaptive_batch_size.sum,count,,,,,0,bentoml,,,
-bentoml.service.request.count,count,,,,,0,bentoml,,,
-bentoml.service.request.duration.bucket,count,,,,,0,bentoml,,,
-bentoml.service.request.duration.count,count,,,,,0,bentoml,,,
-bentoml.service.request.duration.sum,count,,,,,0,bentoml,,,
-bentoml.service.request.in_progress,gauge,,,,,0,bentoml,,,
-bentoml.service.time_since_last_request,gauge,,,,,0,bentoml,,,
+bentoml.endpoint_livez,gauge,,,,"A liveness probe endpoint that checks if the Service is still alive and needs to restart. This metrics reports a 1 if the endpoint is healthy, 0 otherwise.",0,bentoml,,,
+bentoml.endpoint_readyz,gauge,,,,"A readiness probe endpoint that indicates if the Service is ready to accept traffic. This metrics reports a 1 if the endpoint is healthy, 0 otherwise.",0,bentoml,,,
+bentoml.service.adaptive_batch_size.bucket,count,,,,"The number of observations since last data collection that fall within a specific upper_bound tag for adaptive batch sizes used during Service execution histogram measurements.",0,bentoml,,,
+bentoml.service.adaptive_batch_size.count,count,,,,"The number of observations since last data collection for adaptive batch sizes used during Service execution histogram measurements.",0,bentoml,,,
+bentoml.service.adaptive_batch_size.sum,count,,,,"The total batch size units across all observations since last data collection for adaptive batch sizes used during Service execution histogram measurements.",0,bentoml,,,
+bentoml.service.request.count,count,,request,,The number of new requests that a Service has processed since last submission,0,bentoml,,,
+bentoml.service.request.duration.bucket,count,,,,"The number of observations since last data collection that fall within a specific upper_bound tag for request processing duration histogram measurements.",0,bentoml,,,
+bentoml.service.request.duration.count,count,,,,"The number of requests processed since last data collection histogram measurements.",0,bentoml,,,
+bentoml.service.request.duration.sum,count,,second,,"The total sum of request processing time in seconds across all observations since last data collection histogram measurements.",0,bentoml,,,
+bentoml.service.request.in_progress,gauge,,request,,The number of requests that are currently being processed by a Service.,0,bentoml,,,
+bentoml.service.time_since_last_request,gauge,,second,,The amount of time in seconds since the last request was processed by a Service.,0,bentoml,,,