Descripción general de la API

En esta página, se proporciona una breve descripción general de la API de Observability y la API de Telemetry (OTLP).

Acerca de la API de Observability

La API de Observability te permite hacer lo siguiente:

  • Configurar los parámetros predeterminados para los buckets de observabilidad de proyectos, carpetas y organizaciones. Estos parámetros te ayudan a cumplir con los requisitos reglamentarios y de cumplimiento. Puedes configurar lo siguiente:

    • Una ubicación de almacenamiento predeterminada para los buckets de observabilidad nuevos
    • Para cada ubicación, una clave predeterminada de Cloud Key Management Service que se usa para encriptar los buckets de observabilidad nuevos

    Para obtener más información, consulta Establece valores predeterminados para los buckets de observabilidad.

  • Configurar el alcance de observabilidad para tu proyecto Este alcance controla qué recursos buscan las páginas del explorador para obtener datos de registros, métricas y seguimientos. Para obtener más información, consulta Configura los alcances de observabilidad.

  • Mostrar información sobre los buckets de observabilidad en tu Google Cloud proyecto Los datos de seguimiento se almacenan en un bucket de observabilidad. Para obtener información sobre el modelo de datos, consulta Descripción general del almacenamiento.

  • Crear un vínculo en un conjunto de datos, que permite que BigQuery tenga acceso de lectura al conjunto de datos Para aprender a crear un conjunto de datos vinculado, consulta Administra el almacenamiento.

Extremos del servicio

Un extremo de servicio es una URL base que especifica la dirección de red de un servicio de API. La API de Observability admite un extremo global y extremos regionales:

  • Extremo global: observability.googleapis.com.

    Puedes usar el extremo de servicio global para realizar cualquier operación compatible con la API de Observability. Además, para este extremo, el comando list observability buckets te permite reemplazar el campo de ubicación en el parámetro de ruta de acceso por el comodín (-).

  • Extremos regionales: observability.REGION.rep.googleapis.com, en el que REGION es una región admitida. Para obtener una lista de los extremos, consulta Extremo de servicio regional.

    Puedes usar un extremo de servicio regional solo cuando la ubicación proporcionada en el parámetro de ruta de acceso coincide con la región del extremo. Los comandos enviados a estos extremos de servicio fallan si incluyen un comodín o si la ubicación difiere de la región del extremo.

Referencia de la API

Acerca de la API de Telemetry

La API de Telemetry (OTLP) es una implementación del protocolo OTLP de OpenTelemetry. La API de Telemetry proporciona compatibilidad con el ecosistema de OpenTelemetry de código abierto:

  • Registros: La API de Telemetry te permite ingerir registros con formato OTLP en tu proyecto. Para obtener más información, consulta Descripción general de la ingesta de OTLP.

  • Métricas: La API de Telemetry te permite ingerir métricas con formato OTLP en Cloud Monitoring mediante el exportador otlphttp y un OpenTelemetry Collector o un SDK de OpenTelemetry. Para obtener más información, consulta Descripción general de la ingesta de OTLP.

  • Seguimientos: La API de Telemetry te permite enviar datos de seguimiento con formato OTLP a tu proyecto. Además, los límites de seguimiento para la API de Telemetry suelen ser más generosos que los límites para la API de Cloud Trace.

Extremos del servicio

Un extremo de servicio es una URL base que especifica la dirección de red de un servicio de API. La API de Telemetry admite un extremo global y extremos regionales:

  • Extremo global: telemetry.googleapis.com. Para este extremo, después de que Google Cloud Observability complete correctamente todos los pasos de validación, envía los datos a un servicio de backend para su almacenamiento.

  • Extremos regionales: telemetry.REGION.rep.googleapis.com, en el que REGION es una región admitida. Para estos extremos, después de que Google Cloud Observability complete correctamente todos los pasos de validación, envía los datos a un servicio de backend. Este servicio almacena o descarta los datos:

    • Se almacenan los datos de registros y seguimientos. El servicio de backend mueve automáticamente los datos entre regiones cuando es necesario.
    • Los datos de métricas se almacenan solo cuando la etiqueta de ubicación adjunta a los datos coincide con la región del extremo o una zona dentro de esa región.

    Para obtener una lista de los extremos regionales admitidos, consulta las páginas de referencia de la API.

La ingesta de datos de seguimiento puede activar la creación de un bucket de observabilidad. Sin embargo, el uso de un extremo regional no afecta el lugar donde el sistema crea el bucket de observabilidad. El sistema determina la ubicación de un bucket de observabilidad con la configuración predeterminada, las políticas de la organización y el conjunto de ubicaciones de buckets admitidas.

Referencia de la API

Para obtener más información sobre la API de Telemetry, consulta los siguientes documentos: