Adicionar parâmetros de requisição

Por padrão, as integrações do AppSignal rastreiam os parâmetros de requisição para requisições web em bibliotecas suportadas. Isso inclui parâmetros de consulta e o corpo da requisição POST*. Para jobs em segundo plano, armazenamos os argumentos do job nos parâmetros.

*: O pacote AppSignal para PHP e as linguagens suportadas por meio de nosso beta de OpenTelemetry armazenam os parâmetros de consulta da requisição e os dados da payload da requisição separadamente. Veja a seção dados da payload da requisição para mais informações sobre como definir os dados da payload da requisição separadamente.

🔐 Não envie Informações Pessoais Identificáveis (PII) para a AppSignal. Filtre PII (por exemplo, nomes, e-mails) e use um ID, hash ou identificador pseudonimizado no lugar.

Use Link Templates para vinculá-los de volta em sua aplicação.

Você pode definir parâmetros personalizados em uma transação ou span. Modificar os parâmetros de uma transação sobrescreverá os dados definidos pelas instrumentações do AppSignal. Todos os parâmetros são filtrados por nossas integrações antes de serem enviados aos nossos servidores. Veja a tabela abaixo para uma lista de valores raiz aceitos por linguagem. Cada objeto aninhado pode conter valores que resultem em JSON válido (strings, inteiros, floats, booleanos, nulls, etc.).

Linguagem	Valores raiz aceitos
Ruby	Arrays, Hashes
JavaScript	Arrays, Objects
Elixir	Lists, Maps
Python	Lists, Maps
Go	String serializada em JSON
Java	String serializada em JSON
PHP	Arrays, Objects

O exemplo de código abaixo mostra como definir parâmetros de requisição personalizados:

# Values are merged at the top level
Appsignal.add_request_payload(
  :post => {
    :title => "My title",
    :body => "Post text."
  }
)
Appsignal.add_request_payload(:user => { :login => "some_name" })
Appsignal.add_request_payload(:user => { :id => 123 })
# Parameters:
# {
#   :post => { :title => "My title", :body => "Post text." },
#   :user => { :id => 123 }
# }

# Os valores são mesclados no nível superior
Appsignal.add_params(
  :post => {
    :title => "My title",
    :body => "Post text."
  }
)
Appsignal.add_params(:user => { :login => "some_name" })
Appsignal.add_params(:user => { :id => 123 })
# Parâmetros:
# {
#   :post => { :title => "My title", :body => "Post text." },
#   :user => { :id => 123 }
# }

Appsignal.Span.set_sample_data(
  Appsignal.Tracer.root_span,
  "params",
  %{
    post: %{
      title: "My new blog post!",
      body: "Some long blog post text."
    }
  }
)

import { setParams } from "@appsignal/nodejs";

setParams({
  post: {
    title: "My new blog post!",
    body: "Some long blog post text.",
  },
});

from appsignal import set_params

set_params({
  post: {
    title: "My new blog post!",
    body: "Some long blog post text."
  }
})

// Uma configuração adicional é necessária para primeiro buscar ou criar um novo span
import (
	"encoding/json"

	"go.opentelemetry.io/otel/attribute"
	"go.opentelemetry.io/otel/trace"
)

params := map[string]interface{}{
	"param1": "value1",
	"param2": "value2",
	"nested": map[string]interface{}{
		"param3": "value3",
		"param4": "value4",
	},
}
json, _ := json.Marshal(params)
span.SetAttributes(attribute.String("appsignal.request.query_parameters", string(json)))

// Uma configuração adicional é necessária para primeiro buscar ou criar um novo span
import io.opentelemetry.api.trace.Span;
// Estamos usando a biblioteca JSON Jackson
// Você pode precisar adicioná-la ao seu projeto como uma dependência
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.HashMap;
import java.util.Map;

Map<String, Object> queryParams = new HashMap<>();
queryParams.put("param1", "value1");
queryParams.put("param2", "value2");

Map<String, String> nested = new HashMap<>();
nested.put("param3", "value3");
nested.put("param4", "value4");
queryParams.put("nested", nested);

try {
    ObjectMapper mapper = new ObjectMapper();
    String jsonString = mapper.writeValueAsString(queryParams);

    Span span = Span.current();
    span.setAttribute("appsignal.request.query_parameters", jsonString);
} catch (Exception e) {
    // Adicione o tratamento de erros aqui
}

<?php
use Appsignal\Appsignal;

$params = [
    'param1' => 'value1',
    'param2' => 'value2',
    'nested' => [
        'param3' => 'value3',
        'param4' => 'value4',
    ],
];

Appsignal::setParams($params);

Descontinuado no modo collector: os helpers acima não indicam qual tipo de parâmetro estão recebendo, então tudo o que eles reportam se torna o payload da requisição. Eles continuam funcionando no modo agent, e o AppSignal exibe um aviso na primeira vez que você usa um deles no modo collector. Veja tipos de parâmetros para o helper que corresponde aos seus dados.

Para certas linguagens, é necessária uma configuração adicional. Siga as instruções para essas linguagens:

Go
Java

Tipos de parâmetros

O payload da requisição, os parâmetros de consulta da requisição e os parâmetros de função podem ser reportados separadamente, cada um com seu próprio helper:

# The body of a request.
Appsignal.add_request_payload(:post => { :title => "My title" })

# The parameters read from a request's query string.
Appsignal.add_query_parameters(:page => "2")

# The arguments a background job or script was called with.
Appsignal.add_function_parameters(:user_id => 123)

from appsignal import (
  set_function_parameters,
  set_request_payload,
  set_request_query_parameters,
)

# The body of a request.
set_request_payload({"post": {"title": "My title"}})

# The parameters read from a request's query string.
set_request_query_parameters({"page": "2"})

# The arguments a background job or script was called with.
set_function_parameters({"user_id": 123})

No modo collector, cada tipo é reportado como seu próprio atributo. Você pode filtrar e desativar o envio de cada um separadamente. No modo agent, os três gravam no mesmo atributo e aparecem na mesma caixa “Parameters”. No Ruby, os valores das diferentes chamadas são mesclados entre si. No Python, é o último helper chamado cujos valores são reportados.

Dados da payload da requisição

O pacote AppSignal para PHP, a versão 5.0.0 e superiores da gem AppSignal for Ruby, e as linguagens suportadas por meio de nosso beta de OpenTelemetry armazenam os parâmetros de consulta da requisição e os dados da payload da requisição separadamente. Esta seção descreve como definir os dados da payload da requisição de requisições POST. Você pode definir dados personalizados de payload de requisição em um span. Modificar os dados de payload da requisição de um span sobrescreverá os dados definidos pelas instrumentações do AppSignal. Todos os parâmetros são filtrados por nossas integrações antes de serem enviados aos nossos servidores. Veja a tabela abaixo para uma lista de valores raiz aceitos por linguagem. Cada objeto aninhado pode conter valores que resultem em JSON válido (strings, inteiros, floats, booleanos, nulls, etc.).

Linguagem	Valores raiz aceitos
Ruby	Arrays, Hashes
Go	String serializada em JSON
Java	String serializada em JSON
PHP	Arrays, Objects

O exemplo de código abaixo mostra como definir dados personalizados de payload de requisição:

Appsignal.add_request_payload(
  :post => {
    :title => "My title",
    :body => "Post text."
  }
)

// Uma configuração adicional é necessária para primeiro buscar ou criar um novo span
import (
	"encoding/json"

	"go.opentelemetry.io/otel/attribute"
	"go.opentelemetry.io/otel/trace"
)

payload := map[string]interface{}{
	"param1": "value1",
	"param2": "value2",
	"nested": map[string]interface{}{
		"param3": "value3",
		"param4": "value4",
	},
}
json, _ := json.Marshal(payload)
span.SetAttributes(attribute.String("appsignal.request.payload", string(json)))

// Uma configuração adicional é necessária para primeiro buscar ou criar um novo span
import io.opentelemetry.api.trace.Span;
// Estamos usando a biblioteca JSON Jackson
// Você pode precisar adicioná-la ao seu projeto como uma dependência
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.HashMap;
import java.util.Map;

Map<String, Object> payload = new HashMap<>();
payload.put("param1", "value1");
payload.put("param2", "value2");

Map<String, String> nested = new HashMap<>();
nested.put("param3", "value3");
nested.put("param4", "value4");
payload.put("nested", nested);

try {
    ObjectMapper mapper = new ObjectMapper();
    String jsonString = mapper.writeValueAsString(payload);

    Span span = Span.current();
    span.setAttribute("appsignal.request.payload", jsonString);
} catch (Exception e) {
    // Adicione o tratamento de erros aqui
}

<?php
use Appsignal\Appsignal;

$payload = [
    'param1' => 'value1',
    'param2' => 'value2',
    'nested' => [
        'param3' => 'value3',
        'param4' => 'value4',
    ],
];

Appsignal::setPayload($payload);

Para certas linguagens, é necessária uma configuração adicional. Siga as instruções para essas linguagens:

Go
Java

Limitações

Se a aplicação definir os parâmetros de consulta da requisição ou os dados de payload da requisição várias vezes, a gem Ruby mesclará os valores no nível raiz. Para outras integrações, apenas o último valor definido é armazenado.

Veja também

params.expect: Strong Parameters no Rails 8: o Rails 8 adiciona params.expect para permitir e exigir parâmetros em uma única etapa. Ele rejeita formatos de parâmetro inesperados como requisições inválidas.
params.with_defaults: valores padrão para parâmetros do Rails: defina valores de fallback para parâmetros que o navegador pode omitir. Os valores enviados sobrescrevem esses valores padrão.

Página inicial

Guias

Tipos de parâmetros

Dados da payload da requisição

Limitações

Veja também

​Tipos de parâmetros

​Dados da payload da requisição

​Limitações

​Veja também

Tipos de parâmetros

Dados da payload da requisição

Limitações

Veja também