Package google.cloud.observability.v1

Índice

Observabilidade

Serviço que descreve manipuladores para recursos

CreateTraceScope

rpc CreateTraceScope(CreateTraceScopeRequest) returns (TraceScope)

Crie um novo TraceScope.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • observability.traceScopes.create

Para mais informações, consulte a documentação do IAM.
DeleteTraceScope

rpc DeleteTraceScope(DeleteTraceScopeRequest) returns (Empty)

Exclui um TraceScope.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.traceScopes.delete

Para mais informações, consulte a documentação do IAM.
GetScope

rpc GetScope(GetScopeRequest) returns (Scope)

Recebe detalhes de um único escopo.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.scopes.get

Para mais informações, consulte a documentação do IAM.
GetTraceScope

rpc GetTraceScope(GetTraceScopeRequest) returns (TraceScope)

Receba o recurso TraceScope.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.traceScopes.get

Para mais informações, consulte a documentação do IAM.
ListTraceScopes

rpc ListTraceScopes(ListTraceScopesRequest) returns (ListTraceScopesResponse)

Lista os TraceScopes de um projeto em um local específico.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • observability.traceScopes.list

Para mais informações, consulte a documentação do IAM.
UpdateScope

rpc UpdateScope(UpdateScopeRequest) returns (Scope)

Atualiza os parâmetros de um único escopo.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.scopes.update

Para mais informações, consulte a documentação do IAM.
UpdateTraceScope

rpc UpdateTraceScope(UpdateTraceScopeRequest) returns (TraceScope)

Atualiza um TraceScope.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.traceScopes.update

Para mais informações, consulte a documentação do IAM.

CreateTraceScopeRequest

Solicitação para criar um TraceScope.

Campos
parent

string

Obrigatório. O nome completo do recurso do local em que o escopo do rastreamento precisa ser criado.

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Exemplo:

projects/my-project/locations/global
trace_scope_id

string

Obrigatório. Um identificador atribuído pelo cliente para o escopo do rastreamento.
trace_scope

TraceScope

Obrigatório. O novo escopo de rastreamento.

DeleteTraceScopeRequest

Solicitação para excluir um TraceScope.

Campos
name

string

Obrigatório. O nome completo do recurso do escopo de rastreamento a ser excluído:

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

Exemplo:

projects/my-project/locations/global/traceScopes/my-trace-scope

GetScopeRequest

Mensagem para receber um escopo.

Campos
name

string

Obrigatório. Nome do recurso. O formato é:

projects/{project}/locations/{location}/scopes/{scope}

O campo {location} precisa ser definido como global. O campo {scope} precisa ser definido como _Default.

GetTraceScopeRequest

Solicitação para receber um TraceScope.

Campos
name

string

Obrigatório. O nome do recurso do escopo do rastreamento:

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

Exemplo:

projects/my-project/locations/global/traceScopes/my-trace-scope

ListTraceScopesRequest

Solicitação para listar TraceScopes.

Campos
parent

string

Obrigatório. O nome completo do recurso do local para procurar escopos de rastreamento:

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Exemplo:

projects/my-project/locations/global
page_size

int32

Opcional. O número máximo de resultados a serem retornados dessa solicitação.

Valores não positivos são ignorados. A presença de next_page_token na resposta indica que mais resultados podem estar disponíveis.
page_token

string

Opcional. Se estiver presente, recupere o próximo lote de resultados da chamada anterior para esse método. page_token precisa ser o valor de next_page_token da resposta anterior. Os valores de outros parâmetros do método precisam ser idênticos aos da chamada anterior.

ListTraceScopesResponse

Resposta para listar TraceScopes.

Campos
trace_scopes[]

TraceScope

Opcional. Uma lista de escopos de rastreamento.
next_page_token

string

Opcional. Se houver mais resultados do que aparecem nesta resposta, next_page_token será incluído. Para receber o próximo conjunto de resultados, chame o mesmo método novamente usando o valor de next_page_token como page_token.

OperationMetadata

Representa os metadados da operação de longa duração.

Campos
create_time

Timestamp

Somente saída: a hora em que a operação foi criada.
end_time

Timestamp

Somente saída: a hora em que a operação terminou de ser executada.
target

string

Apenas saída. Caminho do recurso definido pelo servidor para o destino da operação.
verb

string

Apenas saída. Nome do verbo executado pela operação.
status_message

string

Apenas saída. Status legível da operação, caso haja um.
requested_cancellation

bool

Apenas saída. Identifica se o usuário solicitou o cancelamento da operação. As operações que foram canceladas têm o valor [Operation.error][] com um google.rpc.Status.code de 1, correspondente a Code.CANCELLED.
api_version

string

Apenas saída. Versão da API usada para iniciar a operação.

Escopo

Mensagem que descreve o objeto Scope

Campos
name

string

Identificador. Nome do recurso. O formato é:

projects/{project}/locations/{location}/scopes/{scope}

O campo {location} precisa ser definido como global. O campo {scope} precisa ser definido como _Default.
update_time

Timestamp

Apenas saída. Carimbo de data/hora da atualização. Observação: o carimbo de data/hora da atualização do escopo padrão fica indefinido inicialmente.
log_scope

string

Obrigatório. O nome completo do recurso de LogScope. Exemplo:

//logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope
trace_scope

string

Obrigatório. O nome do recurso do TraceScope. Exemplo:

projects/myproject/locations/global/traceScopes/my-trace-scope

TraceScope

Um escopo de trace é uma coleção de recursos cujos traces são consultados juntos.

Campos
name

string

Identificador. O nome do recurso do escopo de rastreamento.

Exemplo:

projects/my-project/locations/global/traceScopes/my-trace-scope
resource_names[]

string

Obrigatório. Nomes dos projetos incluídos neste escopo de rastreamento.

  • projects/[PROJECT_ID]

Um escopo de rastreamento pode incluir no máximo 20 projetos.
description

string

Opcional. Descreve o escopo do trace.

O tamanho máximo da descrição é de 8.000 caracteres.
create_time

Timestamp

Apenas saída. O carimbo de data/hora de criação do escopo do trace.
update_time

Timestamp

Apenas saída. O último carimbo de data/hora de atualização do escopo do rastreamento.

UpdateScopeRequest

Mensagem para atualizar um escopo.

Campos
update_mask

FieldMask

Opcional. A máscara de campo é usada para especificar os campos a serem substituídos no recurso "Scope" pela atualização. Os campos especificados em update_mask são relativos ao recurso, não à solicitação completa. Um campo é substituído quando está na máscara. Se o usuário não fornecer uma máscara, todos os campos presentes na solicitação serão substituídos.
scope

Scope

Obrigatório. O recurso que está sendo atualizado.

UpdateTraceScopeRequest

Solicitação para atualizar um TraceScope.

Campos
trace_scope

TraceScope

Obrigatório. O escopo de rastreamento atualizado.
update_mask

FieldMask

Opcional. Lista de campos a serem atualizados.