Este producto no es compatible con el sitio de Datadog seleccionado. ().

Las reglas personalizadas le permiten codificar las expectativas de su organización sobre sus componentes de software, equipos y más. Usted decide los criterios de evaluación, la frecuencia y la entrada de datos. Puede crear reglas personalizadas escribiendo una consulta DDSQL o enviando resultados a través de la API de Scorecards o Datadog Workflow Automation.

Crear reglas personalizadas

  1. Navegue a la página Scorecards y haga clic en Create Rule.
  2. Especifique el nombre de la regla, el Scorecard al que pertenece, una descripción de la regla, el equipo propietario y a qué nivel pertenece la regla.
  3. En Define evaluation logic, elija cómo evalúa Datadog la regla:

El contexto define a qué entidades se aplica una regla. Para las reglas que utilizan un flujo de trabajo o la API de Scorecards, especifique el contexto después de elegir el método de evaluación. El contexto debe incluir al menos un tipo de entidad y puede utilizar metadatos de las definiciones de entidad en IDP Catalog, como kind, team o tier. Para las reglas que utilizan DDSQL, defina el contexto en la cláusula WHERE de la consulta. Para obtener más información, consulte Contexto de las reglas de Scorecard.

Para cambiar la forma en que se evalúa una regla existente, edite la regla y seleccione una opción diferente en Define evaluation logic. Si cambia una regla a DDSQL, debe ejecutar una prueba exitosa antes de poder guardarla, y Datadog eliminará cualquier flujo de trabajo vinculado de la regla. Si cambia una regla de DDSQL a un flujo de trabajo o a la API de Scorecards, Datadog eliminará la consulta DDSQL de la regla.

Evaluar reglas personalizadas mediante DDSQL

Su consulta debe:

  • Devolver un entity_kind, un entity_key y un state para cada entidad.
  • Establezca state en pass, fail o skip.
  • Use la cláusula WHERE para definir el contexto de la regla.

Después de seleccionar Write a DDSQL Query:

La página New Rule con una consulta DDSQL que verifica si cada servicio tiene un enlace a la documentación, un resultado de prueba exitoso y una vista previa de las entidades que cumplen y no cumplen la regla.
  1. Escriba su consulta en el editor. Reemplace cada marcador de posición en la plantilla de consulta o copie una consulta completa desde la pestaña Examples en el panel DDSQL Help. Use la pestaña Data Sources para ver las fuentes de datos y columnas disponibles.
    • Opcionalmente, haga clic en Ask Bits para abrir Bits Chat y redactar una consulta a partir de su prompt.
  2. Haga clic en Run Test para evaluar la consulta en todas las entidades dentro del contexto. Debe ejecutar una prueba exitosa antes de poder guardar la regla.
  3. Revise los resultados en el panel Preview.
  4. Haga clic en Create Rule. Datadog evalúa la consulta cada 4 horas y actualiza un resultado solo si este cambió.
  5. En la página de la regla, vea la consulta y una descripción general de los resultados:
    • La sección Evaluation muestra cuándo se ejecutó la consulta correctamente por última vez.
    • La columna Last Updated muestra la última vez que cambió un resultado.
    • Para editar la consulta, haga clic en Edit.

Evaluar reglas personalizadas mediante la API de Scorecards o la interfaz de usuario

Para agregar y evaluar reglas personalizadas mediante la API de Scorecards:

  1. Especifique el nombre, el Scorecard, la descripción, el propietario, el nivel y el contexto de la regla. Pase estos valores a /scorecard/rules.
  2. Para cada tupla {rule, entity} que evalúe, envíe un resultado de pass, fail o skip a /scorecard/outcomes/batch. Opcionalmente, incluya un comentario que describa el motivo del resultado.
  3. Vea una descripción general de los resultados y comentarios en el panel de Scorecards.

Después de la configuración inicial, las reglas también se pueden habilitar o deshabilitar a través de la API.

Después de crear la regla como se describe en la sección Crear reglas personalizadas, evalúela en la interfaz de usuario de Scorecards:

  1. Navegue hasta la regla que creó y seleccione Edit Outcome junto a la entidad que desea evaluar.
  2. Seleccione el resultado relevante de pass, fail o skip y agregue un comentario opcional que describa el motivo del resultado.
  3. Vea una descripción general de los resultados y comentarios en el panel de Scorecards.

Evaluar reglas personalizadas mediante Workflow Automation

Workflow Automation le permite automatizar la evaluación de sus reglas personalizadas en Datadog mediante la acción Update scorecard rule outcome.

Crear un flujo de trabajo

Después de crear su regla personalizada, elija la opción Add Workflow cuando se le solicite configurar sus criterios de evaluación. Desde allí, puede crear un flujo de trabajo desde cero o utilizar una plantilla.

Flujo de trabajo que evalúa si una entidad tiene un nivel definido en Catalog

Para crear un flujo de trabajo desde cero:

  1. Establezca un horario para que se ejecute su flujo de trabajo.
  2. Haga clic en el icono de más (
  3. ) para agregar un paso. 1. Seleccione la [acción List entity definitions][7] para obtener todas las entidades definidas en Catalog. 1. Haga clic en el icono de más (
    ) para agregar un paso. 1. Seleccione la [For loop][8] para iterar sobre cada entidad una por una. 1. Seleccione la acción necesaria para obtener sus datos de evaluación (por ejemplo, List monitors o Get repository content de GitHub). 1. Transforme los datos devueltos utilizando una función de JavaScript personalizada para generar resultados de aprobado/reprobado para cada entidad. 1. Utilice la [acción Update scorecard rule outcome][6] para enviar resultados a Scorecards. 1. Ejecute el flujo de trabajo para ver cómo aparecen sus evaluaciones en Scorecards para su regla personalizada. 1. Publique el flujo de trabajo; los flujos de trabajo no publicados no se ejecutan automáticamente.

    En lugar de crear un flujo de trabajo desde cero, puede comenzar con una plantilla de Scorecards:

    1. Explore las plantillas de Scorecards y seleccione una.

    2. Edite la plantilla para crear su flujo de trabajo personalizado.

      Nota: Todas las plantillas de Scorecards incluyen la Update scorecard rule outcome acción para enviar resultados a Scorecards. No elimine este paso.

    3. Ejecute el flujo de trabajo para ver cómo aparecen sus evaluaciones en Scorecards para su regla personalizada.

    4. Publique el flujo de trabajo; los flujos de trabajo no publicados no se ejecutan automáticamente.

    Después de crear el flujo de trabajo, este se vincula automáticamente a la regla de Scorecard. Haga clic en el enlace para abrir el flujo de trabajo, realizar cambios y ver detalles como el propietario, el historial de ejecución y la fecha de última modificación.

    El panel detallado para un Scorecard individual, que resalta la automatización de flujo de trabajo vinculada

    Todos los Workflows creados desde la página Scorecards o desde un blueprint de Scorecards se etiquetan automáticamente con source: scorecards para su búsqueda y filtrado.

    Nota: Hacer clic en el botón rojo de desvincular en una regla de Scorecard desvincula el flujo de trabajo de la regla, pero no despublica automáticamente el flujo de trabajo. Para evitar que las evaluaciones se ejecuten, también debe despublicar cualquier flujo de trabajo desvinculado.

    Después de crear su regla personalizada, elija la opción Add Workflow para configurar sus criterios de evaluación. Busque y seleccione un flujo de trabajo existente para vincularlo a la regla.

    También puede vincular un flujo de trabajo existente a cualquier regla personalizada que ya genere resultados:

    1. Haga clic en la regla personalizada.
    2. Seleccione Link Workflow.
    3. Busque un flujo de trabajo y selecciónelo para vincularlo a la regla.

    Lecturas adicionales