Ajouter des paramètres de requête

Par défaut, les intégrations AppSignal suivent les paramètres de requête pour les requêtes web dans les bibliothèques prises en charge. Cela comprend les paramètres de query et le corps de la requête POST*. Pour les jobs en arrière-plan, nous stockons les arguments du job dans les paramètres.

* : le package AppSignal for PHP et les langages pris en charge via notre version bêta OpenTelemetry stockent séparément les paramètres de query de la requête et les données de charge utile de la requête. Consultez la section données de charge utile de la requête pour plus d’informations sur la manière de définir séparément les données de charge utile de la requête.

🔐 N’envoyez pas d’informations personnelles identifiables (PII) à AppSignal. Filtrez les PII (par exemple, noms, e-mails) et utilisez un identifiant, un hash ou un identifiant pseudonymisé à la place.

Utilisez les Link Templates pour les relier dans votre application.

Vous pouvez définir des paramètres personnalisés sur une transaction ou un span. Modifier les paramètres d’une transaction écrasera les données définies par les instrumentations AppSignal. Tous les paramètres sont filtrés par nos intégrations avant d’être envoyés à nos serveurs. Consultez le tableau ci-dessous pour la liste des valeurs racines acceptées par langage. Chaque objet imbriqué peut contenir des valeurs qui produisent du JSON valide (chaînes, entiers, flottants, booléens, valeurs nulles, etc.).

Langage	Valeurs racines acceptées
Ruby	Arrays, Hashes
JavaScript	Arrays, Objects
Elixir	Lists, Maps
Python	Lists, Maps
Go	Chaîne sérialisée JSON
Java	Chaîne sérialisée JSON
PHP	Arrays, Objects

L’exemple de code ci-dessous montre comment définir des paramètres de requête personnalisés :

# 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 }
# }

# Values are merged at the top level
Appsignal.add_params(
  :post => {
    :title => "My title",
    :body => "Post text."
  }
)
Appsignal.add_params(:user => { :login => "some_name" })
Appsignal.add_params(:user => { :id => 123 })
# Parameters:
# {
#   :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."
  }
})

// Additional setup is required to first fetch or create a new 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)))

// Additional setup is required to first fetch or create a new span
import io.opentelemetry.api.trace.Span;
// We're using the Jackson JSON library
// You may need to add it to your project as a dependency
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) {
    // Add error handling here
}

<?php
use Appsignal\Appsignal;

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

Appsignal::setParams($params);

Obsolète en mode collector : les helpers ci-dessus n’indiquent pas de quel type de paramètres il s’agit, donc tout ce qu’ils signalent devient la charge utile de la requête. Ils continuent de fonctionner en mode agent, et AppSignal affiche un avertissement la première fois que vous en utilisez un en mode collector. Consultez types de paramètres pour trouver le helper adapté à vos données.

Pour certains langages, une configuration supplémentaire est requise. Veuillez suivre les instructions pour ces langages :

Go
Java

Types de paramètres

Les charges utiles de requête, les paramètres de query de la requête et les paramètres de fonction peuvent être signalés séparément, chacun via son propre 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})

En mode collector, chaque type est signalé comme son propre attribut. Vous pouvez filtrer et désactiver l’envoi de chacun séparément. En mode agent, les trois écrivent dans le même attribut et apparaissent dans le même encadré « Parameters ». En Ruby, les valeurs des différents appels sont fusionnées entre elles. En Python, c’est le dernier helper appelé dont les valeurs sont signalées.

Données de charge utile de la requête

Le package AppSignal for PHP, la version 5.0.0 et supérieure du gem AppSignal for Ruby, et les langages pris en charge via notre version bêta OpenTelemetry stockent séparément les paramètres de query de la requête et les données de charge utile de la requête. Cette section décrit comment définir les données de charge utile de la requête à partir des requêtes POST. Vous pouvez définir des données de charge utile de requête personnalisées sur un span. Modifier les données de charge utile de requête d’un span écrasera les données définies par les instrumentations AppSignal. Tous les paramètres sont filtrés par nos intégrations avant d’être envoyés à nos serveurs. Consultez le tableau ci-dessous pour la liste des valeurs racines acceptées par langage. Chaque objet imbriqué peut contenir des valeurs qui produisent du JSON valide (chaînes, entiers, flottants, booléens, valeurs nulles, etc.).

Langage	Valeurs racines acceptées
Ruby	Arrays, Hashes
Go	Chaîne sérialisée JSON
Java	Chaîne sérialisée JSON
PHP	Arrays, Objects

L’exemple de code ci-dessous montre comment définir des données de charge utile de requête personnalisées :

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

// Additional setup is required to first fetch or create a new 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)))

// Additional setup is required to first fetch or create a new span
import io.opentelemetry.api.trace.Span;
// We're using the Jackson JSON library
// You may need to add it to your project as a dependency
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) {
    // Add error handling here
}

<?php
use Appsignal\Appsignal;

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

Appsignal::setPayload($payload);

Pour certains langages, une configuration supplémentaire est requise. Veuillez suivre les instructions pour ces langages :

Go
Java

Limitations

Si l’application définit plusieurs fois les paramètres de query de requête ou les données de charge utile de requête, le gem Ruby fusionnera les valeurs au niveau racine. Pour les autres intégrations, seule la dernière valeur définie est stockée.

Voir aussi

params.expect : Strong Parameters dans Rails 8 : Rails 8 ajoute params.expect pour autoriser et exiger des paramètres en une seule étape. Les requêtes dont les paramètres ont une forme inattendue sont rejetées.
params.with_defaults : valeurs par défaut pour les paramètres Rails : définissez des valeurs de repli pour les paramètres que le navigateur peut omettre. Les valeurs soumises remplacent ces valeurs par défaut.

Accueil

Guides

Types de paramètres

Données de charge utile de la requête

Limitations

Voir aussi

​Types de paramètres

​Données de charge utile de la requête

​Limitations

​Voir aussi

Types de paramètres

Données de charge utile de la requête

Limitations

Voir aussi