From d9adbe8531da1840977f2898ef1a1b11b2d00436 Mon Sep 17 00:00:00 2001 From: Esther Kim Date: Tue, 7 Jan 2025 08:55:38 -0500 Subject: [PATCH] Update reference link to the fluent bit log collection docs (#2576) * Update reference link to the fluent bit log collection docs * Update fluentbit/README.md * sync models --------- Co-authored-by: Kyle-Neale --- fluentbit/README.md | 12 ++++++++---- .../fluentbit/config_models/instance.py | 12 ++++++------ 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/fluentbit/README.md b/fluentbit/README.md index 480424e287..37ee377da1 100644 --- a/fluentbit/README.md +++ b/fluentbit/README.md @@ -2,7 +2,7 @@ ## Overview -This check monitors [Fluent Bit][1] metrics through the Datadog Agent. For sending logs to Datadog with Fluent Bit, see the [Fluent Bit][11] documentation to learn about the Datadog Fluent Bit output plugin. +This check monitors [Fluent Bit][1] metrics through the Datadog Agent. To send logs to Datadog with Fluent Bit and to learn about the Datadog Fluent Bit output plugin, see the [Fluent Bit][11] documentation. ## Fluent Bit configuration Fluent Bit doesn't expose its internal metrics by default. You need to enable the built-in HTTP server that exposes the metrics endpoint. @@ -18,8 +18,6 @@ Follow the instructions below to install and configure this check for an Agent r ### Installation -### Installation - For Agent v7.21+ / v6.21+, follow the instructions below to install the Fluent Bit check on your host. See [Use Community Integrations][3] to install with the Docker Agent or earlier versions of the Agent. 1. Run the following command to install the Agent integration: @@ -68,6 +66,12 @@ The Fluent Bit integration does not include any service checks. Need help? Contact [Datadog support][10]. +## Further Reading + +Additional helpful documentation, links, and articles: + +- [Send Fluent Bit Logs to Datadog][11] + [1]: https://fluentbit.io [2]: https://docs.fluentbit.io/manual/administration/monitoring @@ -79,5 +83,5 @@ Need help? Contact [Datadog support][10]. [8]: https://github.com/DataDog/integrations-extras/blob/master/fluentbit/metadata.csv [9]: https://github.com/DataDog/integrations-extras/blob/master/fluentbit/assets/service_checks.json [10]: https://docs.datadoghq.com/help/ -[11]: https://docs.datadoghq.com/integrations/fluentbit/ +[11]: https://docs.datadoghq.com/logs/guide/fluentbit/ [12]: https://docs.datadoghq.com/developers/integrations/python/ diff --git a/fluentbit/datadog_checks/fluentbit/config_models/instance.py b/fluentbit/datadog_checks/fluentbit/config_models/instance.py index 3a106bde68..151a4464ed 100644 --- a/fluentbit/datadog_checks/fluentbit/config_models/instance.py +++ b/fluentbit/datadog_checks/fluentbit/config_models/instance.py @@ -25,7 +25,7 @@ class AuthToken(BaseModel): writer: Optional[MappingProxyType[str, Any]] = None -class ExtraMetric(BaseModel): +class ExtraMetrics(BaseModel): model_config = ConfigDict( arbitrary_types_allowed=True, extra='allow', @@ -44,7 +44,7 @@ class MetricPatterns(BaseModel): include: Optional[tuple[str, ...]] = None -class Metric(BaseModel): +class Metrics(BaseModel): model_config = ConfigDict( arbitrary_types_allowed=True, extra='allow', @@ -64,7 +64,7 @@ class Proxy(BaseModel): no_proxy: Optional[tuple[str, ...]] = None -class ShareLabel(BaseModel): +class ShareLabels(BaseModel): model_config = ConfigDict( arbitrary_types_allowed=True, frozen=True, @@ -97,7 +97,7 @@ class InstanceConfig(BaseModel): exclude_metrics: Optional[tuple[str, ...]] = None exclude_metrics_by_labels: Optional[MappingProxyType[str, Union[bool, tuple[str, ...]]]] = None extra_headers: Optional[MappingProxyType[str, Any]] = None - extra_metrics: Optional[tuple[Union[str, MappingProxyType[str, Union[str, ExtraMetric]]], ...]] = None + extra_metrics: Optional[tuple[Union[str, MappingProxyType[str, Union[str, ExtraMetrics]]], ...]] = None headers: Optional[MappingProxyType[str, Any]] = None histogram_buckets_as_distributions: Optional[bool] = None hostname_format: Optional[str] = None @@ -114,7 +114,7 @@ class InstanceConfig(BaseModel): kerberos_principal: Optional[str] = None log_requests: Optional[bool] = None metric_patterns: Optional[MetricPatterns] = None - metrics: Optional[tuple[Union[str, MappingProxyType[str, Union[str, Metric]]], ...]] = None + metrics: Optional[tuple[Union[str, MappingProxyType[str, Union[str, Metrics]]], ...]] = None metrics_endpoint: str min_collection_interval: Optional[float] = None namespace: Optional[str] = Field(None, pattern='\\w*') @@ -130,7 +130,7 @@ class InstanceConfig(BaseModel): rename_labels: Optional[MappingProxyType[str, Any]] = None request_size: Optional[float] = None service: Optional[str] = None - share_labels: Optional[MappingProxyType[str, Union[bool, ShareLabel]]] = None + share_labels: Optional[MappingProxyType[str, Union[bool, ShareLabels]]] = None skip_proxy: Optional[bool] = None tag_by_endpoint: Optional[bool] = None tags: Optional[tuple[str, ...]] = None