Introducción a Integrations

Descripción general

Esta es una guía para el uso de Integrations. Si busca información sobre cómo crear una nueva Integration, consulte la página Crear una nueva Integration.

Una Integration, en el nivel más alto, es cuando usted ensambla un sistema unificado a partir de unidades que generalmente se consideran por separado. En Datadog, usted puede utilizar Integrations para reunir todas las métricas y registros de su infraestructura y obtener información sobre el sistema unificado en su conjunto; usted puede ver las piezas individualmente y también cómo las piezas individuales están afectando al todo.

Nota: Es mejor comenzar a recopilar métricas en sus proyectos lo antes posible en el proceso de desarrollo, pero usted puede comenzar en cualquier etapa.

Datadog ofrece tres tipos principales de Integrations:

Las Integrations - basadas en Agent se instalan con el Datadog Agent y utilizan un método de clase de Python llamado check para definir las métricas que se deben recopilar. Las Integrations - basadas en autenticación (rastreador) se configuran en Datadog, donde usted proporciona las credenciales para obtener métricas con la API. Estas incluyen Integrations populares como Slack, AWS, Azure y PagerDuty. Las Integrations de - biblioteca utilizan la Datadog API para permitirle hacer un seguimiento de las aplicaciones según el lenguaje en el que estén escritas, como Node.js o Python.

También puede crear una verificación personalizada para definir y enviar métricas a Datadog desde su sistema interno único.

Configuración de una Integration

El paquete del Datadog Agent incluye Integrations compatibles oficialmente con Datadog, en integrations core. Para utilizar esas Integrations, descargue el Datadog Agent. Las Integrations basadas en la comunidad se encuentran en integrations extras. Para obtener más información sobre la instalación o administración de estas Integrations, consulte la guía de administración de Integrations.

Permisos

Se requiere el permiso de Gestión de Integrations para interactuar con un mosaico de Integration. Consulte roles RBAC para obtener más información.

Claves de API y de aplicación

Para instalar el Datadog Agent, necesita una clave de API. Si el Agent ya está descargado, asegúrese de configurar la clave de API en el archivo datadog.yaml. Para utilizar la mayoría de las funcionalidades adicionales de Datadog además del envío de métricas y eventos, necesita una clave de aplicación. Puede gestionar las claves de API y de aplicación de sus cuentas en la página de Configuración de API.

Instalación

Si desea conectarse con una integración basada en rastreador o biblioteca, navegue a ese proveedor en la página de Integrations para obtener instrucciones específicas sobre cómo conectarse. Para otras integraciones compatibles, instale el Datadog Agent. La mayoría de las integraciones son compatibles con los Agents en contenedores: Docker y Kubernetes. Después de descargar el Agent, vaya a la página Integrations para encontrar instrucciones de configuración específicas para cada integración.

Configuración de integraciones del Agent

Puede configurar las integraciones del Agent de forma remota en toda su flota desde una interfaz de usuario y una API centralizadas con Fleet Automation, en lugar de editar conf.yaml archivos en cada servidor. Descubra servicios detectados automáticamente, limite una configuración a cualquier subconjunto de servidores mediante etiqueta o filtro de servidor, y realice la implementación en cada Agent coincidente en una sola acción. Esto requiere Remote Configuration y la versión 7.76 o posterior del Agent en máquinas virtuales Linux o Windows.

La mayoría de los parámetros de configuración son específicos de la integración individual. Configure las integraciones del Agent navegando a la carpeta conf.d en la raíz del directorio de configuración de su Agent. Cada integración tiene una carpeta llamada <INTEGRATION_NAME>.d, que contiene el archivo conf.yaml.example. Este archivo de ejemplo enumera todas las opciones de configuración disponibles para la integración en particular.

Para activar una integración determinada:

  1. Cambie el nombre del archivo conf.yaml.example (en la carpeta <INTEGRATION_NAME>.d correspondiente) a conf.yaml.
  2. Actualice los parámetros requeridos dentro del archivo de configuración recién creado con los valores correspondientes a su entorno.
  3. Reinicie el Datadog Agent.

Nota: Todos los archivos de configuración siguen el formato documentado en @param specification.

Por ejemplo, este es el archivo de configuración conf.yaml mínimo necesario para recopilar métricas y registros de la integración de apache:

init_config:
  service: apache

instances:
    - apache_status_url: http://localhost/server-status?auto

logs:
    - type: file
      path: /var/log/apache2/access.log
      source: apache
      sourcecategory: http_web_access
    - type: file
      path: /var/log/apache2/error.log
      source: apache
      sourcecategory: http_web_access

Para hacer un seguimiento de múltiples instancias de Apache en la misma verificación del Agent, agregue instancias adicionales a la sección instances:

init_config:

instances:
    - apache_status_url: "http://localhost/server-status?auto"
      service: local-apache

    - apache_status_url: "http://<REMOTE_APACHE_ENDPOINT>/server-status?auto"
      service: remote-apache

Intervalo de recolección

El intervalo de recolección predeterminado para todas las Integrations estándar de Datadog es de 15 segundos. Para cambiar el intervalo de recolección, utilice el parámetro min_collection_interval. Para obtener más detalles, consulte Updating the collection interval.

Etiquetado

El etiquetado es una parte clave del filtrado y la agregación de los datos que llegan a Datadog desde muchas fuentes. Para obtener más información sobre el etiquetado, consulte Getting started with tags.

Si define etiquetas en el archivo datadog.yaml, las etiquetas se aplican a todos los datos de sus Integrations. Una vez que haya definido una etiqueta en datadog.yaml, todas las nuevas Integrations la heredan.

Por ejemplo, establecer service en su archivo de configuración es la configuración del Agent recomendada para monitorear sistemas independientes y separados.

Para unificar mejor su entorno, también se recomienda configurar la etiqueta env en el Agent. Para obtener más información, consulte Unified Service Tagging.

Configuración de etiquetas por verificación

Puede personalizar el comportamiento de las etiquetas para verificaciones individuales, anulando la configuración global a nivel de Agent:

  1. Deshabilitar etiquetas de Autodiscovery

    De forma predeterminada, las métricas reportadas por las integraciones incluyen etiquetas detectadas automáticamente desde el entorno. Por ejemplo, las métricas reportadas por una verificación de Redis que se ejecuta dentro de un contenedor incluyen etiquetas asociadas con el contenedor, como image_name. Puede desactivar este comportamiento configurando el parámetro ignore_autodiscovery_tags en true.

  2. Establecer la cardinalidad de etiquetas por verificación de integración

    Puede definir el nivel de cardinalidad de etiquetas (baja, orquestador o alta) por cada verificación utilizando el parámetro check_tag_cardinality. Esto anula la configuración global de cardinalidad de etiquetas definida en la configuración del Agent.

init_config:
# Ignores tags coming from autodiscovery
ignore_autodiscovery_tags: true

# Override global tag cardinality setting
check_tag_cardinality: low

# Rest of the config here

Para entornos en contenedores, también puede establecer estos parámetros a través de Kubernetes Autodiscovery annotations.

Validación

Para validar la configuración de su Agent e Integrations, ejecute el subcomando status del Agent y busque la nueva configuración en la sección Checks.

Instalación de múltiples Integrations

Instalar más de una Integration es cuestión de agregar la información de configuración a un nuevo archivo conf.yaml en la carpeta <INTEGRATIONS>.d correspondiente. Busque los parámetros requeridos para la nueva Integration en el archivo conf.yaml.example, agréguelos al nuevo archivo conf.yaml y luego siga los mismos pasos para validar su configuración.

Integraciones autodetectadas

Si configura la recopilación de procesos, Datadog autodetecta las tecnologías que se ejecutan en sus servidores. Esto identifica las Integrations de Datadog que pueden ayudarle a hacer un seguimiento de estas tecnologías. Estas Integrations autodetectadas se muestran en la Integrations search:

Integrations autodetectadas

Cada Integration tiene uno de cuatro tipos de estado:

  • Detected: La tecnología se está ejecutando en un servidor, pero la Integration no se ha instalado ni configurado y solo se están recopilando métricas parciales. Configure la integración para una cobertura completa. Para encontrar una lista de hosts que ejecutan una tecnología autodetectada, abra el mosaico de integraciones y seleccione la pestaña Hosts.
  • Installed: Esta integración está instalada y configurada en un servidor.
  • Available: Todas las integraciones que no entran en las categorías Installed y Detected.
  • Missing Data: No se han detectado métricas de integración en las últimas 24 horas.

Security practices

Para obtener información sobre cómo Datadog maneja sus datos y otras consideraciones de seguridad, consulte el Security documentation.

Control de acceso granular

De forma predeterminada, el acceso a los recursos de integración (cuentas, servicios, webhooks) no está restringido. Se pueden usar controles de acceso granulares para restringir el comportamiento de usuarios, equipos, roles o toda su organización a nivel de recurso de integración.

Nota: La opción de acceso restringido solo es visible si la integración admite el control de acceso granular. Para verificar si se admite el control de acceso granular para una integración, revise la documentación de esa integración.

Controles de acceso granulares

  1. Mientras visualiza una integración, navegue a la pestaña Configure y localice el recurso (cuenta, servicio, webhook) al que se deben aplicar los controles de acceso granulares.
  2. Haga clic en Set Permissions.
  3. De forma predeterminada, todos en su organización tienen acceso completo. Haga clic en Restrict Access.
  4. El cuadro de diálogo se actualiza para mostrar que los miembros de su organización tienen acceso Viewer de forma predeterminada.
  5. Use el menú desplegable para seleccionar uno o más equipos, roles o usuarios que puedan editar el monitor. Nota: También se requiere el permiso Integrations Manage para editar recursos individuales.
  6. Haga clic en Add.
  7. El cuadro de diálogo se actualiza para mostrar los permisos actualizados.
  8. Haga clic en Save. La página de integración se actualiza automáticamente con los permisos actualizados.

Nota: Para mantener el acceso de edición al recurso, el sistema requiere que incluya al menos un rol o equipo del que usted sea miembro antes de guardar.

Para restaurar el acceso general a un recurso de integración con acceso restringido, siga los pasos a continuación:

  1. Mientras visualiza una integración, navegue a la pestaña Configure y localice el recurso (cuenta, servicio, webhook) al que se le debe restaurar el acceso general.
  2. Haga clic en Set Permissions.
  3. Haga clic en Restore Full Access.
  4. Haga clic en Save. La página de integración se actualiza automáticamente con los permisos actualizados.

¿Qué sigue?

Después de configurar su primera integración, explore todas las métricas que su aplicación envía a Datadog y utilice estas métricas para comenzar a configurar dashboards y alerts para hacer un seguimiento de sus datos.

Consulte también las soluciones de Log Management, APM y Synthetic Monitoring de Datadog.

Solución de problemas

El primer paso para solucionar problemas de una integración es usar un complemento en su editor de código o usar una de las muchas herramientas en línea para verificar que el YAML sea válido. El siguiente paso es seguir todos los pasos de Agent troubleshooting.

Si continúa teniendo problemas, comuníquese con el Datadog support.

Términos clave

conf.yaml
Usted crea el conf.yaml en la carpeta conf.d/<INTEGRATION_NAME>.d en la raíz de su Agent’s configuration directory. Utilice este archivo para conectar integraciones a su sistema, así como para configurar sus ajustes.
verificación personalizada
Si usted tiene un sistema único que desea hacer un seguimiento, o si va a expandir las métricas ya enviadas por una integración, puede crear una verificación personalizada para definir y enviar métricas a Datadog. Sin embargo, si usted desea hacer un seguimiento de una aplicación de disponibilidad general, un servicio público o un proyecto de código abierto y la integración no existe, considere crear una nueva integración en lugar de una verificación personalizada.
datadog.yaml
Este es el archivo de configuración principal donde usted define cómo el Agent en su conjunto interactúa con sus propias integraciones y con su sistema. Utilice este archivo para actualizar claves de API, proxies, etiquetas de servidor y otros ajustes globales.
evento
Los eventos son mensajes informativos sobre su sistema que son consumidos por the events explorer para que usted pueda crear monitores sobre ellos.
instancia
Usted define y asigna la instancia de lo que sea que esté monitoreando en el archivo conf.yaml. Por ejemplo, en la http_check integration, usted define el nombre asociado con la instancia del punto de conexión HTTP del que está monitoreando el tiempo de actividad y de inactividad. Usted puede hacer un seguimiento de múltiples instancias en la misma integración, y lo hace definiendo todas las instancias en el archivo conf.yaml.
<INTEGRATION_NAME>.d
Si usted tiene una configuración compleja, puede dividirla en múltiples archivos YAML y luego almacenarlos todos en la carpeta <INTEGRATION_NAME>.d para definir la configuración. El Agent carga cualquier archivo YAML válido en la carpeta <INTEGRATION_NAME>.d.
registro
Si el sistema que usted está monitoreando tiene registros, personalice los registros que envía a Datadog utilizando la Log Management solution.
metadata.csv
El archivo que enumera y almacena las métricas recopiladas por cada integración.
métricas
La lista de lo que se recopila de su sistema mediante cada integración. Puede encontrar las métricas para cada integración en el archivo metadata.csv de esa integración y en la tabla Datos recopilados en la página de documentación de la integración. En esa tabla, una métrica enumerada con Shown as <unit> ya tiene una unidad definida en los metadatos de la integración. Una métrica sin esta notación no tiene una unidad establecida de forma predeterminada, por lo que debe configurar una manualmente en la página de metric summary. Para obtener más información sobre las métricas, consulte la página para desarrolladores de Metrics. También puede configurar métricas personalizadas, por lo que si la integración no ofrece una métrica de forma inmediata, generalmente puede agregarla.
parámetros
Utilice los parámetros en el archivo conf.yaml para controlar los accesos entre su fuente de datos de integración y el Agent. El archivo conf.yaml.example de las integraciones individuales tiene enumerados todos los parámetros requeridos y no requeridos.
verificación de servicio
Las verificaciones de servicio son un tipo de monitor utilizado para rastrear el estado de tiempo de actividad del servicio. Para obtener más información, consulte la Service checks guide.
etiquetado
[Tags] are a way to add customization to metrics so that you can filter and visualize them in the most useful way to you.

Lecturas adicionales