Descripción general

El etiquetado se utiliza en todo Datadog para consultar las máquinas y métricas que monitoreas. Sin la capacidad de asignar y filtrar según tags, encontrar problemas en tu entorno y reducirlos lo suficiente para descubrir las verdaderas causas podría ser difícil. Aprende a definir tags en Datadog antes de continuar.

Los tags se pueden configurar de varias maneras diferentes:

• En el archivo de configuración del Agente de Datadog o en cada archivo de configuración de integración individual
• A través de la interfaz de usuario de Datadog
• Con la API de Datadog
• Con DogStatsD

Métodos para asignar tags

Archivo de configuración

tags: ["<KEY_1>:<VALUE_1>", "<KEY_2>:<VALUE_2>", "<KEY_3>:<VALUE_3>"]

tags:
    - "<KEY_1>:<VALUE_1>"
    - "<KEY_2>:<VALUE_2>"
    - "<KEY_3>:<VALUE_3>"

# Set the hostname (default: auto-detected)
# Must comply with RFC-1123, which permits only:
# "A" to "Z", "a" to "z", "0" to "9", and the hyphen (-)
hostname: mymachine.mydomain

tags: <KEY_1>:<VALUE_1>, <KEY_2>:<VALUE_2>, <KEY_3>:<VALUE_3>

# Set the hostname (default: auto-detected)
# Must comply with RFC-1123, which permits only:
# "A" to "Z", "a" to "z", "0" to "9", and the hyphen (-)
hostname: mymachine.mydomain

Herencia de integración

El método más eficiente para asignar tags es confiar en la herencia de integración. Los tags que asignes a tus AWS instances, recetas de Chef y otras integraciones son heredados automáticamente por los hosts y métricas que envías a Datadog.

Para entornos contenedorizados, se recomienda seguir la documentación de unified service tagging para lograr un único punto de configuración en toda tu telemetría de Datadog.

Integraciones en la nube

Las integraciones en la nube se basan en autenticación. Datadog recomienda utilizar el mosaico principal de integración en la nube (AWS, Azure, Google Cloud, etc.) y instalar el Agente donde sea posible. Nota: Si decides usar solo el Agent, algunos tags de integración no están disponibles.

Web integrations

Web integrations se basan en autenticación. Las métricas se recopilan mediante llamadas a la API. Nota: los CamelCase tags se convierten en guiones bajos por Datadog, por ejemplo TestTag –> test_tag.

Variables de entorno

Después de instalar el Datadog Agent en entornos contenerizados, puedes establecer tus tags de host utilizando la variable de entorno DD_TAGS en el archivo de configuración principal de tu Agent. Si especificas múltiples tags, sepáralos con un espacio.

Nota: La variable de entorno DD_TAGS utiliza espacios en blanco para separar tags. Por ejemplo, DD_TAGS="key1:val1 key2:val2" establece dos tags. Un valor como DD_TAGS="test:this is a test" produce cuatro tags separados (test:this, is, a, test) porque cada token separado por espacios se trata como su propio tag. Para incluir espacios en los valores de los tags, establece los tags a través de la configuración YAML o mediante anotaciones de integración, en su lugar. Esos métodos convierten los espacios en blanco en guiones bajos (por ejemplo, test:this is a test se convierte en test:this_is_a_test).

Datadog recopila automáticamente tags comunes de Docker, Kubernetes, ECS, Swarm, Mesos, Nomad y Rancher. Para extraer aún más tags, utiliza las siguientes opciones:

Ejemplos:

DD_KUBERNETES_POD_LABELS_AS_TAGS='{"app":"kube_app","release":"helm_release"}'
DD_CONTAINER_LABELS_AS_TAGS='{"com.docker.compose.service":"service_name"}'

Al usar DD_KUBERNETES_POD_LABELS_AS_TAGS, puedes usar comodines en el formato:

{"foo": "bar_%%label%%"}

Por ejemplo, {"app*": "kube_%%label%%"} se resuelve al nombre de etiqueta kube_application para la etiqueta application. Además, {"*": "kube_%%label%%"} agrega todas las etiquetas de pod como etiquetas con el prefijo kube_.

Al usar la variable DD_CONTAINER_LABELS_AS_TAGS dentro de un archivo de Docker Swarm docker-compose.yaml, elimina los apóstrofes, por ejemplo:

- DD_CONTAINER_LABELS_AS_TAGS={"com.docker.compose.service":"service_name"}

Al agregar etiquetas a los contenedores de Docker, la colocación de la palabra clave labels: dentro del archivo docker-compose.yaml es importante. Para evitar problemas, sigue la documentación de Docker unified service tagging.

Si el contenedor necesita ser etiquetado fuera de esta configuración, coloca la palabra clave labels: dentro de la sección services:, no dentro de la sección deploy:. Coloca la palabra clave labels: dentro de la sección deploy: solo cuando el servicio necesita ser etiquetado. El Agente de Datadog no tiene etiquetas para extraer de los contenedores sin esta colocación.

A continuación se muestra un archivo de muestra docker-compose.yaml que muestra esta colocación de etiquetas. En el ejemplo a continuación, las etiquetas en la sección myapplication:, my.custom.label.project y my.custom.label.version tienen valores únicos. Usar la variable de entorno DD_CONTAINER_LABELS_AS_TAGS en la sección datadog: extrae las etiquetas y produce estas etiquetas para el contenedor myapplication:

Dentro del contenedor myapplication las etiquetas son: my.custom.label.project y my.custom.label.version

Después de que el Agente extrae las etiquetas del contenedor, las etiquetas son: projecttag:projectA versiontag:1

Ejemplo de docker-compose.yaml:

services:
  datadog:
    volumes:
      - '/var/run/docker.sock:/var/run/docker.sock:ro'
      - '/proc:/host/proc:ro'
      - '/sys/fs/cgroup/:/host/sys/fs/cgroup:ro'
    environment:
      - DD_API_KEY= "<DATADOG_API_KEY>"
      - DD_CONTAINER_LABELS_AS_TAGS={"my.custom.label.project":"projecttag","my.custom.label.version":"versiontag"}
      - DD_TAGS="key1:value1 key2:value2 key3:value3"
    image: 'registry.datadoghq.com/agent:latest'
    deploy:
      restart_policy:
        condition: on-failure
      mode: replicated
      replicas: 1
  myapplication:
    image: 'myapplication'
    labels:
      my.custom.label.project: 'projectA'
      my.custom.label.version: '1'
    deploy:
      restart_policy:
        condition: on-failure
      mode: replicated
      replicas: 1

Define las variables en tu datadog.yaml personalizado, o configúralas como mapas JSON en estas variables de entorno. La clave del mapa es el nombre de la fuente (label/envvar), y el valor del mapa es el nombre de la etiqueta de Datadog.

Cardinalidad de etiquetas

Hay dos variables de entorno que establecen la cardinalidad de etiquetas: DD_CHECKS_TAG_CARDINALITY y DD_DOGSTATSD_TAG_CARDINALITY. Debido a que DogStatsD tiene un precio diferente, la configuración de cardinalidad de etiquetas de DogStatsD se separa para proporcionar la oportunidad de una configuración más detallada. De lo contrario, estas variables funcionan de la misma manera: pueden tener valores low, orchestrator o high. Ambas tienen como valor predeterminado low, que incluye etiquetas a nivel de clúster de Kubernetes.

Las diferentes configuraciones de cardinalidad apuntan a:

• low: etiquetas a nivel de clúster de Kubernetes, como kube_namespace.
• orchestrator: etiquetas a nivel de pod, como pod_name.
• high: etiquetas a nivel de contenedor, como container_id.

Dependiendo de la cardinalidad, hay un conjunto diferente de etiquetas listas para usar para Kubernetes y OpenShift, y para Docker, Rancher y Mesos. Para ECS y Fargate, establecer la variable en orchestrator agrega la etiqueta task_arn.

Notas:

• Enviar etiquetas de contenedor para métricas de DogStatsD puede crear más métricas (una por contenedor en lugar de una por host). Esto puede afectar la facturación de sus métricas personalizadas.
• En métricas, las marcas de tiempo se redondean al segundo más cercano. Si hay puntos con la misma marca de tiempo, el punto más reciente sobrescribe los anteriores. Establecer una mayor cardinalidad puede ayudar a prevenir este problema.

Trazas

El SDK de Datadog se puede configurar con variables de entorno, propiedades del sistema o a través de la configuración en el código. La documentación de configuración de trazado de Datadog tiene información sobre opciones de etiquetado y configuración para cada SDK. También puede seguir la documentación de etiquetado de servicio unificado para configurar su SDK para el etiquetado de servicio unificado.

Independientemente del SDK utilizado, los metadatos de span deben respetar una estructura de árbol tipada. Cada nodo del árbol se divide por un . y es de un solo tipo.

Por ejemplo, un nodo no puede ser tanto un objeto (con sub-nodos) como una cadena:

{
  "key": "value",
  "key.subkey": "value_2"
}

Los metadatos de span anteriores son inválidos ya que el valor de key no puede referirse a una cadena ("value") y también a un subárbol ({"subkey": "value_2"}).

INTERFAZ DE USUARIO

Asigne etiquetas de servidor en la interfaz de usuario utilizando la página Mapa de servidores. Haga clic en cualquier hexágono (servidor) para mostrar la superposición del servidor en la parte inferior de la página. Luego, en la sección Usuario, haga clic en el botón Agregar etiquetas. Ingrese las etiquetas como una lista separada por comas, luego haga clic en Guardar etiquetas. Los cambios realizados en las etiquetas de servidor en la interfaz de usuario pueden tardar hasta cinco minutos en aplicarse.

Asigne etiquetas de servidor en la interfaz de usuario utilizando la página de Lista de infraestructura. Haga clic en cualquier servidor para mostrar la superposición del servidor a la derecha de la página. Luego, en la sección Usuario, haga clic en el botón Agregar etiquetas. Ingrese las etiquetas como una lista separada por comas, luego haga clic en Guardar etiquetas. Los cambios realizados en las etiquetas de host en la interfaz de usuario pueden tardar hasta cinco minutos en aplicarse. Después de agregar etiquetas, asegúrese de que sean visibles en la interfaz de usuario antes de intentar agregar más etiquetas.

Desde la página de Administrar Monitores, seleccione la casilla de verificación junto a cada monitor para agregar etiquetas (seleccione uno o varios monitores). Haga clic en el botón Editar Etiquetas. Ingrese una etiqueta o seleccione una utilizada anteriormente. Luego haga clic en Agregar Etiqueta tag:name o Aplicar Cambios. Si se agregaron etiquetas anteriormente, se pueden asignar múltiples etiquetas a la vez utilizando las casillas de verificación de etiquetas. Para más información, consulte la documentación de Administrar Monitores.

Al crear un monitor, asigne etiquetas de monitor en el paso 4 Diga lo que está sucediendo o Notifique a su Equipo:

Cree agregaciones percentiles dentro de Métricas de Distribución aplicando una lista permitida de hasta diez etiquetas a una métrica. Esto crea una serie temporal para cada combinación potencialmente consultable de valores de etiquetas. Para más información sobre cómo contar métricas personalizadas y series temporales emitidas desde métricas de distribución, consulte Métricas personalizadas.

Aplique hasta diez etiquetas. No se aceptan etiquetas excluyentes:

El mosaico de integración de AWS le permite asignar etiquetas adicionales a todas las métricas a nivel de cuenta, así como a los registros enviados a través de disparadores de suscripción automática. Utilice una lista de etiquetas separadas por comas en la forma <KEY>:<VALUE>.

Al crear un SLO, asigne etiquetas en el paso 3, Agregar nombre y etiquetas:

API

Web server 1: api.metric('page.views', [(1317652676, 100), ...], host="example_prod_1")
Web server 2: api.metric('page.views', [(1317652676, 500), ...], host="example_prod_2")

Web server 1: api.metric('page.views', [(1317652676, 100), ...], tags=['domain:example.com'])
Web server 2: api.metric('page.views', [(1317652676, 500), ...], tags=['domain:example.com'])

sum:page.views{domain:example.com}

sum:page.views{domain:example.com} by {host}

DogStatsD

Agrega etiquetas a cualquier métrica, evento o verificación de servicio que envíes a DogStatsD. Por ejemplo, compara el rendimiento de dos algoritmos etiquetando una métrica de temporizador con la versión del algoritmo:

@statsd.timed('algorithm.run_time', tags=['algorithm:one'])
def algorithm_one():
    # Do fancy things here ...

@statsd.timed('algorithm.run_time', tags=['algorithm:two'])
def algorithm_two():
    # Do fancy things (maybe faster?) here ...

Nota: Etiquetar es una extensión específica de Datadog a StatsD.

Se requiere una consideración especial al asignar la etiqueta host a las métricas de DogStatsD. Para más información sobre la clave de etiqueta del servidor, consulta la documentación de Envío de Métricas: DogStatsD.

Lectura Adicional

Más enlaces, artículos y documentación útiles:

Introducción a los tagsDOCUMENTACIÓN Aprende a usar tags en DatadogDOCUMENTACIÓN