Visão geral da API

Esta página oferece uma breve visão geral da API Observability e da API Telemetry (OTLP).

Sobre a API Observability

A API Observability permite fazer o seguinte:

  • Configure as configurações padrão para buckets de observabilidade de projetos, pastas e organizações. Essas configurações ajudam você a atender aos requisitos regulamentares e de conformidade. É possível configurar o seguinte:

    • Um local de armazenamento padrão para novos buckets de observabilidade.
    • Para cada local, uma chave padrão do Cloud Key Management Service. Essa chave é usada para criptografar novos buckets de observabilidade.

    Para mais informações, consulte Definir padrões para buckets de observabilidade.

  • Configure o escopo de observabilidade do seu projeto. Esse escopo controla quais recursos são pesquisados pelas páginas do Explorer para dados de registro, métrica e trace. Para mais informações, consulte Configurar escopos de observabilidade.

  • Liste informações sobre os buckets de observabilidade no seu Google Cloud projeto. Os dados de trace são armazenados em um bucket de observabilidade. Para informações sobre o modelo de dados, consulte Visão geral do armazenamento.

  • Crie um link em um conjunto de dados, que permite que o BigQuery tenha acesso de leitura ao conjunto de dados. Para saber como criar um conjunto de dados vinculado, consulte Gerenciar armazenamento.

Endpoints de Serviço

Um endpoint de serviço é um URL de base que especifica o endereço de rede de um serviço de API. A API Observability oferece suporte a um endpoint global e endpoints regionais:

  • Endpoint global: observability.googleapis.com.

    É possível usar o endpoint de serviço global para realizar todas as operações com suporte da API Observability. Além disso, para esse endpoint, o comando de buckets de observabilidade da lista permite substituir o campo de local no parâmetro de caminho pelo caractere curinga (-).

  • Endpoints regionais: observability.REGION.rep.googleapis.com, em que REGION é uma região com suporte. Para uma lista de endpoints, consulte Endpoint de serviço regional.

    Só é possível usar um endpoint de serviço regional quando o local fornecido no parâmetro de caminho corresponde à região do endpoint. Os comandos enviados a esses endpoints de serviço falham se incluírem um caractere curinga ou se o local for diferente da região do endpoint.

Referência da API

Sobre a API Telemetry

A API Telemetry (OTLP) é uma implementação do protocolo OTLP do OpenTelemetry. A API Telemetry oferece compatibilidade e suporte para o ecossistema de código aberto do OpenTelemetry:

  • Registros: a API Telemetry permite ingerir registros de log formatados em OTLP no seu projeto. Para mais informações, consulte Gravar registros OTLP na API Telemetry.

  • Métricas: a API Telemetry permite ingerir métricas formatadas em OTLP no Cloud Monitoring usando o exportador otlphttp e um coletor do OpenTelemetry ou um SDK do OpenTelemetry. Para mais informações, consulte Visão geral da ingestão de métricas OTLP.

  • Traces: a API Telemetry permite enviar dados de trace formatados em OTLP para seu projeto. Além disso, os limites de trace para a API Telemetry costumam ser mais generosos do que os limites para a API Cloud Trace.

Endpoints de Serviço

Um endpoint de serviço é um URL de base que especifica o endereço de rede de um serviço de API. A API Telemetry oferece suporte a um endpoint global e endpoints regionais:

  • Endpoint global: telemetry.googleapis.com. Para esse endpoint, depois que o Google Cloud Observability concluir todas as etapas de validação, ele enviará os dados para um serviço de back-end para armazenamento.

  • Endpoints regionais: telemetry.REGION.rep.googleapis.com, em que REGION é uma região com suporte. Para esses endpoints, depois que o Google Cloud Observability concluir todas as etapas de validação, ele enviará os dados para um serviço de back-end. Esse serviço armazena ou descarta os dados:

    • Os dados de registro e trace são armazenados. O serviço de back-end move automaticamente os dados entre regiões quando necessário.
    • Os dados de métricas são armazenados somente quando o rótulo de local anexado aos dados corresponde à região do endpoint ou a uma zona nessa região.

    Para uma lista de endpoints regionais com suporte, consulte as páginas de referência da API.

A ingestão de dados de trace pode acionar a criação de um bucket de observabilidade. No entanto, o uso de um endpoint regional não afeta o local em que o sistema cria o bucket de observabilidade. O sistema determina o local de um bucket de observabilidade usando configurações padrão, políticas da organização e o conjunto de locais de bucket com suporte.

Referência da API

Para mais informações sobre a API Telemetry, consulte os seguintes documentos: