web_transaction (API do agente Python)

Sintaxe

newrelic.agent.web_transaction(application=None, name=None, group=None, scheme=None, host=None, port=None, request_method=None, request_path=None, query_string=None, headers=None)

Usado para instrumento de transação da web.

Requisitos

Versão do agente 4.16.0.116 ou superior

Descrição

Este decorador Python pode ser usado para instrumento de transação da web. As transações marcadas com este decorador são mostradas na interface do APM em transação da web e são separadas das transações da web.

Se você não puder usar o decorador, um destes formatos de chamada pode ser mais útil:

The wrapper: se você souber antecipadamente onde estão as funções específicas que deseja rastrear, poderá usar o decorador web_transaction . Mas se você não conhece todas as funções que precisam ser rastreadas (por exemplo, se elas estão sendo pesquisadas dinamicamente como parte de um sistema de roteamento), então você deve usar o WebTransactionWrapper para agrupar a função no momento da inscrição ou no momento da ligação.
The path-based wrapper: o formulário wrapper baseado em caminho é wrap_web_transaction.

Para obter mais informações sobre as diferenças e os usos dessas formas de função, consulte Formatos de chamada de variáveis.

Parâmetro

Parâmetro decorador

newrelic.agent.web_transaction(application=None, name=None, group=None, scheme=None, host=None, port=None, request_method=None, request_path=None, query_string=None, headers=None)

Parâmetro para essas chamadas:

Parâmetro	Descrição
`application` Instância do aplicativo	Opcional. O aplicativo sob o qual os dados serão relatados. Se ficar sem valor, o aplicativo especificado na configuração do agente (arquivo de configuração ou variável de ambiente) será usado. Para obter mais informações sobre como gerar um objeto de aplicativo, consulte o método `application()` .
`name` string ou função	Opcional. O nome da transação. Pode ser uma função que aceita um parâmetro callable_name. O valor padrão é `None`. Por padrão, o nome será o nome da função à qual o decorator foi aplicado, mas você pode sobrescrever isso fornecendo este nome.
`group` string ou função	Opcional. O `group` representa a estrutura de nomenclatura do parâmetro `name` . Isto é usado na interface para definir o tipo de transação. Se não for fornecido, o grupo assume `Function` por padrão, na expectativa de que o nome tenha o formato `module:class.function` ou `module:function` e represente o nome da função sendo executada. Se você estiver criando um grupo personalizado, recomendamos prefixá-lo com `Python/`. Pode ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.
`scheme` string ou função	Opcional. A parte do esquema do URL da solicitação. Pode ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.
`host` string ou função	Opcional. A parte do host do URL da solicitação. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.
`port` inteiro ou função	Opcional. A parte da porta do URL da solicitação. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.
`request_method` string ou função	Opcional. O método de requisição HTTP, como GET ou POST. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.
`request_path` string ou função	Opcional. O restante do caminho da URL da requisição. Poderia ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.
`query_string` string ou função	Opcional. A parte da URL da requisição que vem após o ponto de interrogação. Pode ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.
`headers` iterável ou dict ou função	Opcional. Os cabeçalhos da requisição HTTP Um iterável de iteráveis de dois itens [name, value] ou dict de `{name:value}`, onde name é o nome do cabeçalho, e value é o valor do cabeçalho. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.

Parâmetro

Descrição

application

Instância do aplicativo

Opcional. O aplicativo sob o qual os dados serão relatados. Se ficar sem valor, o aplicativo especificado na configuração do agente (arquivo de configuração ou variável de ambiente) será usado.

Para obter mais informações sobre como gerar um objeto de aplicativo, consulte o método application() .

name

string ou função

Opcional. O nome da transação. Pode ser uma função que aceita um parâmetro callable_name. O valor padrão é None. Por padrão, o nome será o nome da função à qual o decorator foi aplicado, mas você pode sobrescrever isso fornecendo este nome.

group

string ou função

Opcional. O group representa a estrutura de nomenclatura do parâmetro name . Isto é usado na interface para definir o tipo de transação.

Se não for fornecido, o grupo assume Function por padrão, na expectativa de que o nome tenha o formato module:class.function ou module:function e represente o nome da função sendo executada. Se você estiver criando um grupo personalizado, recomendamos prefixá-lo com Python/. Pode ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.

scheme

string ou função

Opcional. A parte do esquema do URL da solicitação. Pode ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.

host

string ou função

Opcional. A parte do host do URL da solicitação. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.

port

inteiro ou função

Opcional. A parte da porta do URL da solicitação. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.

request_method

string ou função

Opcional. O método de requisição HTTP, como GET ou POST. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.

request_path

string ou função

Opcional. O restante do caminho da URL da requisição. Poderia ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.

query_string

string ou função

Opcional. A parte da URL da requisição que vem após o ponto de interrogação. Pode ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.

headers

iterável ou dict ou função

Opcional. Os cabeçalhos da requisição HTTP Um iterável de iteráveis de dois itens [name, value] ou dict de {name:value}, onde name é o nome do cabeçalho, e value é o valor do cabeçalho. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.

Parâmetro do wrapper:

newrelic.agent.WebTransactionWrapper(wrapped, application=None, name=None, group=None, scheme=None, host=None, port=None, request_method=None, request_path=None, query_string=None, headers=None)

WebTransactionWrapper usa os mesmos parâmetros do decorador web_transaction e este parâmetro wrapped adicional:

Parâmetro	Descrição
`wrapped` método	Obrigatório. O método a ser rastreado.
`name` string ou função	Opcional. O nome da transação. Pode ser uma função que aceita um parâmetro callable_name. O valor padrão é `None`. Por padrão, o nome será o nome da função à qual o decorator foi aplicado, mas você pode sobrescrever isso fornecendo este nome.
`group` string ou função	Opcional. O `group` representa a estrutura de nomenclatura do parâmetro `name` . Isto é usado na interface para definir o tipo de transação. Se não for fornecido, o grupo assume `Function` por padrão, na expectativa de que o nome tenha o formato `module:class.function` ou `module:function` e represente o nome da função sendo executada. Se você estiver criando um grupo personalizado, recomendamos prefixá-lo com `Python/`. Pode ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.
`scheme` string ou função	Opcional. A parte do esquema do URL da solicitação. Pode ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.
`host` string ou função	Opcional. A parte do host do URL da solicitação. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.
`port` inteiro ou função	Opcional. A parte da porta do URL da solicitação. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.
`request_method` string ou função	Opcional. O método de requisição HTTP, como GET ou POST. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.
`request_path` string ou função	Opcional. O restante do caminho da URL da requisição. Poderia ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.
`query_string` string ou função	Opcional. A parte da URL da requisição que vem após o ponto de interrogação. Pode ser uma função que aceita os mesmos parâmetros que a função sendo encapsulada.
`headers` iterável ou dict ou função	Opcional. Os cabeçalhos da requisição HTTP Um iterável de iteráveis de dois itens [name, value] ou dict de `{name:value}`, onde name é o nome do cabeçalho, e value é o valor do cabeçalho. Pode ser uma função que aceita os mesmos parâmetros que a função que está sendo encapsulada.

Parâmetro baseado em caminho:

newrelic.agent.wrap_web_transaction(module, object_path, application=None, name=None, group=None, scheme=None, host=None, port=None, request_method=None, request_path=None, query_string=None, headers=None)

wrap_web_transaction leva o mesmo parâmetro do decorador web_transaction mais estes parâmetros adicionais:

Parâmetro	Descrição
`module` módulo ou string	Obrigatório. O módulo que contém a função/atividade web que você está instrumentado.
`object_path` corda	Obrigatório. O caminho para o módulo.

Parâmetro

Descrição

module

módulo ou string

Obrigatório. O módulo que contém a função/atividade web que você está instrumentado.

object_path

corda

Obrigatório. O caminho para o módulo.

Exemplos

`web_transaction`

Aqui está um exemplo de uso do decorador web_transaction:

@newrelic.agent.web_transaction()
def get():
    ...

`WebTransactionWrapper`

Um exemplo de uso do WebTransactionWrapper:

task = newrelic.agent.WebTransactionWrapper(get_next_task())
result = task(*args, **kwargs)

Esta tradução de máquina é fornecida para sua comodidade.

Sintaxe.css-21sua1{background:none;border:none;width:0;padding:0;}

Requisitos

Descrição

Parâmetro

Parâmetro decorador

Parâmetro do wrapper:

Parâmetro baseado em caminho:

Exemplos

web_transaction

WebTransactionWrapper

Sintaxe

`web_transaction`

`WebTransactionWrapper`