Empezando con el Portal interno para desarrolladores
El Portal interno para desarrolladores (IDP) de Datadog te ayuda a unificar los metadatos de software, la telemetría en tiempo real y los workflows (UI) / procesos (generic) de los desarrolladores en una única plataforma. En esta guía se explica cómo configurar cada componente central de IDP:
- Software Catalog: Inventario en tiempo real de entidades y entornos, enriquecido con metadatos de propiedad y operativos.
- Scorecards: Miden la adopción de las prácticas recomendadas de ingeniería mediante evaluaciones basadas en reglas.
- Acciones de Self-Service: Permiten a los desarrolladores ejecutar tareas estandarizadas con un solo clic.
- Informes de ingeniería: Visualiza las métricas de calidad, fiabilidad y cumplimiento en todo tu stack tecnológico.
- Páginas de información general: Ofrecen a los desarrolladores y equipos una vista personalizada de sus entidades, incidencias y elementos de acción.
Tanto si empiezas desde cero como si te integras con sistemas existentes como Backstage o ServiceNow, utiliza esta guía para empezar con IDP.
Requisitos previos
Si aún no lo has hecho, crea una cuenta de Datadog.
Step (UI) / paso (generic) 1: Rellenar Software Catalog
IDP comienza con Software Catalog, un inventario en tiempo real de los componentes clave de tu arquitectura de software. En Datadog, se denominan entidades y pueden representar servicios individuales, API o sistemas agrupados.
Puedes añadir entidades de:
Empieza con una definición básica para registrar la entidad y, a continuación, enriquécela con metadatos para añadir propiedad y contexto operativo, entre otros:
- Información sobre la propiedad y contactos del equipo
- Documentación, dashboards, runbooks
- Pipelines de despliegue y enlaces de configuración
- Datos de disponibilidad de la producción mediante el etiquetado unificado de servicios
El siguiente ejemplo define una entidad system que representa una aplicación compuesta de varios servicios. Incluye metadatos como nombre para mostrar, propiedad, contactos, documentación relacionada, integraciones y componentes de servicios asociados.
apiVersion: v3
kind: system
metadata:
name: myapp
displayName: My App
tags:
- tag:value
links:
- name: shopping-cart runbook
type: runbook
url: https://runbook/shopping-cart
- name: shopping-cart architecture
provider: gdoc
url: https://google.drive/shopping-cart-architecture
type: doc
- name: shopping-cart Wiki
provider: wiki
url: https://wiki/shopping-cart
type: doc
- name: shopping-cart source code
provider: github
url: http://github/shopping-cart
type: repo
contacts:
- name: Support Slack
type: slack
contact: https://www.slack.com/archives/shopping-cart
owner: myteam
additionalOwners:
- name: opsTeam
type: operator
integrations:
pagerduty:
serviceURL: https://www.pagerduty.com/service-directory/Pshopping-cart
spec:
components:
- service:myservice
- service:otherservice
Lee la Guía de configuración de Software Catalog para aprender a añadir o importar entidades y revisa la referencia del modelo de entidad para conocer los detalles del esquema.
Step (UI) / paso (generic) 2: Evaluar la calidad de las entidades con scorecards
Utiliza scorecards para evaluar si las entidades cumplen las normas de tu organización. Los scorecards pueden medir:
- Cobertura de la monitorización
- Preparación para producción
- Protocolo de seguridad
- Adopción de herramientas internas
- Propiedad y documentación
Los scorecards de Datadog incluyen 10 reglas predefinidas que abarcan prácticas de observabilidad, etiquetado de propiedad y puntos de control de preparación para la producción. Puedes agrupar las reglas en niveles para clasificarlas según su nivel de criticidad 1 (expectativas básicas), nivel 2 (prácticas recomendadas) y nivel 3 (objetivos avanzados/aspiracionales).
Además de utilizar las reglas predeterminadas, puedes definir reglas personalizadas que reflejen tus normas internas:
- Ve a la page (página) Scorecards y haz clic en Crear regla.
- Especifica el nombre de la regla, el scorecard al que pertenece, una descripción y el equipo propietario.
- Envía un resultado de
pass, fail, o skip para cada entidad de una de las siguientes maneras: - Consulta un información general de los resultados en la page (página) Scorecards.
Obtén más información sobre la configuración de scorecards y las reglas personalizadas en la Documentación sobre Scorecards.
Step (UI) / paso (generic) 3: Utilizar acciones de Self-Service
Las acciones de Self-Service te permiten ejecutar tareas repetibles a través de una interfaz de usuario o API. Por ejemplo, utiliza acciones de Self-Service para:
Las acciones pueden estar respaldadas por sistemas de automatización como Terraform, acciones de GitHub o scripts internos. Las acciones de Self-Service ofrecen más de 1000 integraciones creadas previamente con herramientas a través de la gestión de código fuente (por ejemplo, GitHub y GitLab), gestión de tickets e incidents (incidentes) (por ejemplo, Jira, ServiceNow y PagerDuty), chat (por ejemplo, Slack y Microsoft Teams), proveedores de la nube (por ejemplo, AWS, GCP y Azure), etc. Puedes conectarte con cualquier endpoint adicional, incluidos los recursos privados, aprovechando las solicitudes HTTP y los ejecutores privados de acción.
Empieza explorando las acciones de Self-Service Bibiloteca de blueprint (esquema) en Datadog para ver ejemplos de aplicaciones que puedes personalizar para tu case (incidencia) de uso.
Para empezar a automatizar los flujos de trabajo de los desarrolladores, explora la Documentación sobre acciones de Self-Service.
Los informes de ingeniería ofrecen una visión general de:
- Rendimiento de los scorecards en todos equipos
- Tendencias de fiabilidad en toda la organización basadas en los SLOs y en el rendimiento de incidents (incidentes)
- Velocidad y estabilidad del desarrollo de software
Explora Informes de ingeniería en la aplicación Datadog. Estos informes se generan automáticamente y se actualizan en tiempo real.
Lee la Documentación sobre informes de ingeniería para obtener más detalles sobre los informes disponibles y las opciones de configuración.
En las páginas de información general se muestran métricas de alto nivel y elementos de acción adaptados a cada colaborador y equipo.
Comienza con la page (página) de información general del desarrollador, en la que se muestra:
- Tus tickets de Jira y PR de GitHub abiertos
- Monitores, incidencias, SLOs y scorecards de tu equipo
- Problemas activos, errores y alertas Watchdog
Para obtener consejos de configuración y personalización, lee la Documentación sobre páginas de información general.
Referencias adicionales
Más enlaces, artículos y documentación útiles:
