API de surveillance React Native

Initialisez ` Instana ` dans votre App classe componentDidMount():

export default class App extends Component {
  componentDidMount() {
    Instana.setup(YOUR_INSTANA_APP_KEY, YOUR_INSTANA_REPORTING_URL, null);
    // Alternatively with configuration options
    Instana.setup(YOUR_INSTANA_APP_KEY, YOUR_INSTANA_REPORTING_URL, {'collectionEnabled': false});
  }
}

Le code suivant est une définition de TypeScript :

setup(your_instana_app_key: string, your_instana_app_reportingUrl: string, options?: Object): void;
setup(your_instana_app_key: string, your_instana_app_reportingUrl: string, {collectionEnabled: boolean}): void;

Chaque instance de l'agent « Instana » dispose d'un identifiant de session unique que vous pouvez utiliser à d'autres fins dans votre application.

static getSessionID()

Le code suivant est une définition de TypeScript :

getSessionID(): Promise<string>;

Instana L'agent assure la surveillance automatique des requêtes HTTP.

Instana peut segmenter les informations d'application mobile par vues logiques. Vous pouvez définir le nom de la vue à l'aide de la Instana.setView(String) méthode. La vue est alors associée à toutes les balises surveillées jusqu'à ce que la vue change lorsque setView est appelée à nouveau.

N'utilisez pas de noms techniques ou génériques tels que « Class » WebViewActivity (par exemple) pour définir des vues. Utilisez plutôt des noms lisibles pour les vues (par exemple, product detail page ou payment selection). En se concentrant sur les expériences des utilisateurs, les membres de l'équipe qui n'ont pas une connaissance intime de la base de code peuvent comprendre les informations fournies.

static setView(String name)

Le code suivant est une définition de TypeScript :

setView(name: string): void;

Des informations spécifiques à l'utilisateur peuvent, le cas échéant, être envoyées avec les données transmises à Instana. Ces informations peuvent ensuite être utilisées pour débloquer davantage de fonctionnalités, telles que :

• Calculer le nombre d'utilisateurs affectés par les erreurs
• Filtrer les données pour des utilisateurs spécifiques
• Voir quel utilisateur a déclenché une modification de la vue ou une demande d' HTTP

Par défaut, Instana n'associe aucune information permettant d'identifier l'utilisateur aux balises. Vous devez connaître les lois applicables en matière de protection des données. Identifiez les utilisateurs à l'aide d'un ID utilisateur. Dans le cas d' Instana s, il s'agit d'un élément String transparent utilisé uniquement pour calculer certains indicateurs. userName et userEmail peuvent également être utilisés pour avoir accès à plus de filtres et à une meilleure présentation des informations sur l'utilisateur.

Dans les cas où vous traitez des utilisateurs anonymes et n'avez donc pas accès aux identifiants d'utilisateur, vous pouvez également utiliser les identifiants de session. Les identifiants de session ne sont pas aussi utiles que les identifiants d'utilisateur pour filtrer les données, mais ils constituent un bon indicateur pour calculer les indicateurs relatifs aux utilisateurs concernés ou aux utilisateurs uniques. Définissez un nom d'utilisateur tel que Anonymous pour établir une distinction claire entre les utilisateurs authentifiés et les utilisateurs non authentifiés. Les ID session peuvent être des données sensibles (en fonction de l'infrastructure ou de la plateforme utilisée). Envisagez de hacher les identifiants de session afin d'éviter de transmettre à Instana des données susceptibles de permettre l'accès.

Les données déjà transmises au serveur d' Instana ne peuvent pas être modifiées a posteriori. C'est pourquoi il est important d'appeler cette méthode ` API ` dès que possible lors du lancement de l'application.

static setUserID(String ID)
static setUserName(String email)
static setUserEmail(String name)

Le code suivant est une définition de TypeScript :

setUserID(id: string): void;
setUserName(name: string): void;
setUserEmail(email: string): void;

Des métadonnées arbitraires peuvent être associées à toutes les données transmises à Instana. Vous pouvez l'utiliser pour suivre les valeurs de configuration de l'interface utilisateur, les paramètres, les indicateurs de fonctionnalité et tout autre contexte qui pourrait être utile à l'analyse.

static setMeta(String key, String value)

Le code suivant est une définition de TypeScript :

setMeta(key: string, value: string): void;

Les événements personnalisés permettent de signaler à Instana les activités atypiques, les interactions importantes et les durées personnalisées. Cela peut s'avérer particulièrement utile lorsque vous analysez des erreurs non interceptées (éléments de navigation) et que vous effectuez le suivi d'un plus grand nombre d'attributs de performance.

static reportEvent(String eventName, {
  startTime: Number startTime,
  duration: Number duration,
  viewName: String viewName,
  backendTraceId: String backendTraceId,
  meta: Map meta
})

Le code suivant est une définition de TypeScript :

reportEvent(eventName: string, options?: {
  startTime?: number;
  duration?: number;
  viewName?: string;
  meta?: Map<string, string>;
  backendTracingId?: string;
  customMetric?: number;
 }): void;

Les URL peuvent être ignorées en fournissant des expressions régulières ou en les ajoutant à la liste ignoreURLs. Cette fonction est utile lorsque vous souhaitez ignorer toutes les requêtes HTTP contenant des données sensibles, telles qu'un mot de passe.

L'agent doit convertir chaque chaîne que vous fournissez à la setIgnoreURLsByRegex méthode en une expression régulière native pour chaque plateforme prise en charge. Vous pouvez suivre les rejets de promesses, qui vous informent de tout problème rencontré par l'agent pendant que vous interprétez vos données.

static setIgnoreURLsByRegex([]String regexArray)

Le code suivant est une définition de TypeScript :

setIgnoreURLsByRegex(regexArray: Array<string>): Promise<any>;

Les paramètres de requête figurant dans les URL collectés peuvent contenir des données sensibles. Par conséquent, l'agent « Instana » prend en charge la définition de modèles d'expressions régulières pour les clés de paramètres de requête dont les valeurs doivent être masquées. Toute valeur devant être expurgée est remplacée par la chaîne de caractères <redacted>. La censure est effectuée au sein de l'agent Instana avant que celui-ci n'envoie ses rapports au serveur Instana. Par conséquent, les données confidentielles ne sont pas transmises aux serveurs d' Instana. pour y être traitées et ne peuvent donc pas être analysées dans l'interface utilisateur de Instana ni récupérées via Instana API.

Par défaut, l'agent « Instana » est configuré avec une liste de trois expressions régulières permettant de masquer automatiquement les valeurs des paramètres de requête pour les clés « password », « key » et « secret ».

static setRedactHTTPQueryByRegex([]String regexArray)

Le code suivant est une définition de TypeScript :

setRedactHTTPQueryByRegex(regexArray: Array<string>): Promise<any>;

Si vous le souhaitez, l'agent « Instana » peut enregistrer les en-têtes « HTTP » de chaque requête et réponse suivies.

Une liste de motifs regex peut être définie pour déterminer quels en-têtes doivent être capturés.

Si le même nom d'en-tête est présent à la fois dans une demande et dans sa réponse, seule la valeur de l'en-tête de la réponse est prise en compte.

static setCaptureHeadersByRegex([]String regexArray)

Le code suivant est une définition de TypeScript :

setCaptureHeadersByRegex(regexArray: Array<string>): Promise<any>;

Par défaut, si l'envoi d'une balise échoue, l'agent Instana tente de la renvoyer jusqu'à ce qu'elle soit envoyée avec succès. Cependant, ce comportement ne fonctionne pas bien avec certains réseaux cellulaires. En activant la fonction « mode d'émission lente », vous pouvez régler l'intervalle d'émission de la balise sur la valeur attribuée au slowSendInterval paramètre. Chaque envoi se compose d'une seule balise au lieu d'un lot (un maximum de 100 balises dans un lot). L'agent « Instana » reste en mode d'envoi lent jusqu'à ce qu'une balise ait été envoyée avec succès.

La plage de valeurs valides pour le slowSendInterval paramètre est comprise entre 2 et 3 600 secondes.

Le code suivant est une définition de TypeScript :

setup(key: string, reportingUrl: string, {slowSendInterval: number}): void;

Par défaut, la session de l'utilisateur est suivie et un identifiant universel unique (UUID) est généré de manière aléatoire. Cet ID reste inchangé lors de l'installation de l'application. Vous pouvez configurer la durée de validité de l'identifiant de session utilisateur à l'aide du usiRefreshTimeIntervalInHrs paramètre.

Les valeurs de paramètre suivantes indiquent le statut de l'ID de session utilisateur:

• Nombre négatif: cette valeur indique que l'ID de session utilisateur n'expire jamais. La valeur par défaut est -1.

• Nombre positif : Cette valeur signifie que l'ID de la session de l'utilisateur est actualisé après le délai fixé. Un nouvel UUID est généré et utilisé.

• Zéro: Cette valeur indiquée par 0.0 signifie que l'ID de session utilisateur est désactivé.

Le code suivant est une définition de TypeScript :

setup(key: string, reportingUrl: string, {usiRefreshTimeIntervalInHrs: number}): void;
 

Ce paramètre vous permet de définir le nombre maximal de balises pouvant être envoyées au cours d'un intervalle de temps donné. Le tableau suivant répertorie les options disponibles et les limites de balise correspondantes. Par défaut, 0 (DEFAULT_LIMITS) est sélectionné.

Lorsque l'option enableW3CHeaders ( Boolean , facultative) est activée, l'agent React Native inclut les traceparent en-têtes tracestate et dans tous les appels API surveillés. Ces en-têtes permettent la corrélation au niveau du backend, même si celui-ci n'est pas équipé de l'agent d' Instana. Dans ce cas, vous devez utiliser un outil de surveillance compatible (tel que OpenTelemetry ) pour exporter les détails des traces du backend vers le backend Instana. Si cette option est désactivée, la corrélation avec le backend n'est possible que si celui-ci est également surveillé par l'agent d' Instana. La valeur par défaut est false.