Extensão do Google Stackdriver Logging

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Versão 1.3.7

Grave entradas nos registros do Stackdriver Logging.

Este conteúdo oferece uma referência para configurar e usar essa extensão.

Pré-requisitos

Antes de usar essa extensão em um proxy de API, você precisa:

1. No IAM, atribua as funções Logging > Logs Writer e Logging > Logs Viewer ao membro do projeto que vai representar sua extensão no sistema do Stackdriver Logging. Para instruções sobre como conceder papéis, consulte Como conceder papéis a uma conta de serviço para recursos específicos. Para mais informações sobre papéis de registro, consulte o Guia de controle de acesso.

2. Use o Console do GCP para gerar uma chave para a conta de serviço.

3. Use o conteúdo do arquivo JSON de chave resultante ao adicionar e configurar a extensão usando a referência de configuração.

Essa extensão pode ser chamada por uma política ExtensionCallout localizada no PostClientFlow. Se você quiser usar a política ExtensionCallout para chamar essa extensão de um PostClientFlow, verifique se a flag features.allowExtensionsInPostClientFlow está definida como true na sua organização.

• Se você for cliente do Apigee Edge para nuvem pública, entre em contato com o suporte do Apigee Edge para garantir que a flag features.allowExtensionsInPostClientFlow esteja definida como true na sua organização.

• Se você for cliente do Apigee Edge para nuvem privada, use a API Atualizar propriedades da organização para definir a flag features.allowExtensionsInPostClientFlow como true.

Sobre o Stackdriver Logging

O Stackdriver Logging faz parte do conjunto de produtos do Stackdriver no Google Cloud Platform (GCP). Estão incluídos o armazenamento para registros, uma interface do usuário chamada Visualizador de registros e uma API para gerenciar registros de maneira programática. Com o Stackdriver Logging, você pode ler e gravar entradas de registro, procurar e filtrar seus registros, exportar seus registros e criar métricas com base neles.

No momento, essa extensão grava entradas no registro. Para mais informações, consulte os documentos do Stackdriver Logging.

Amostras

Os exemplos a seguir ilustram como configurar o suporte a ações de extensão do Stackdriver Logging usando a política ExtensionCallout.

Registro global

A política a seguir grava a mensagem "This is a test" em um registro chamado example-log no recurso global do Stackdriver. No uso real, a mensagem provavelmente estará contida em uma variável de fluxo cujo valor você definiu em outro lugar no proxy da API.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Logging-Extension">
    <DisplayName>Logging Connector</DisplayName>
    <Connector>stackdriver-extension-sample</Connector>
    <Action>log</Action>
    <Input><![CDATA[{
        "logName": "example-log",
        "metadata": {
            "resource": {
                "type": "global",
                "labels": {
                    "project_id": "my-test"
                }
            }
        },
        "message": "This is a test"
    }]]></Input>
</ConnectorCallout>

Este conteúdo oferece uma referência para configurar e usar essa extensão. Para saber como configurar uma extensão usando o console da Apigee, consulte Adicionar e configurar uma extensão.

Ações

log

Grava uma mensagem no registro.

Essa ação grava uma entrada de registro do Stackdriver. As entradas de registro consistem em metadados e dados de entrada. Para mais informações sobre entradas de registro, consulte a Referência de entrada. Para saber mais sobre o conteúdo da propriedade metadata, consulte o objeto LogEntry na documentação do Stackdriver Logging.

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "stackdriver-log-name-to-use",
  "metadata" : JSON-structured-metadata,
  "message" : "data-to-log-as-entry"
}]]></Input>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "stackdriver-log-name-to-use",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : "data-to-log-as-entry"
}]]></Input>

Parâmetros de solicitação

Resposta

Nenhuma, se a mensagem foi gravada no registro. Caso contrário, um erro será exibido. Consulte também Como depurar uma extensão.

Referência de configuração

Use as informações a seguir ao configurar e implantar essa extensão para uso em proxies de API.

Propriedades de extensão comuns

As propriedades a seguir estão presentes para cada extensão.

Propriedades deste pacote de extensão

Especifique valores para as seguintes propriedades de configuração específicas desta extensão.