API de monitoramento do React Native

Inicialize ` Instana ` na sua 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});
  }
}

O código a seguir é uma definição 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;

Cada instância do agente do Instana possui um identificador de sessão exclusivo que você pode utilizar para outros fins em seu aplicativo.

static getSessionID()

O código a seguir é uma definição de TypeScript:

getSessionID(): Promise<string>;

Instana O agente oferece monitoramento automático das solicitações do HTTP.

O Instana pode segmentar insights de app móvel por visualizações lógicas. Você pode definir o nome da visualização usando o Instana.setView(String) método. A visualização é então associada a todos os beacons monitorados até que a visualização seja alterada quando setView for chamado novamente.

Não utilize nomes técnicos ou genéricos, como Class (por exemplo, WebViewActivity), para definir visualizações. Em vez disso, use nomes legíveis para as exibições (por exemplo, product detail page ou payment selection). Ao se concentrar nas experiências do usuário, os membros da equipe que não têm conhecimento profundo da base de código podem entender os insights fornecidos.

static setView(String name)

O código a seguir é uma definição de TypeScript:

setView(name: string): void;

Opcionalmente, informações específicas do usuário podem ser enviadas junto com os dados transmitidos para Instana. Essas informações podem então ser usadas para desbloquear mais recursos, tais como:

• Calcule o número de usuários afetados por erros
• Filtrar dados para usuários específicos
• Veja qual usuário iniciou uma alteração na visualização ou uma solicitação de " HTTP "

Por padrão, o site Instana não associa nenhuma informação que permita identificar o usuário aos beacons. Você deve estar ciente das respectivas leis de proteção de dados. Identificar usuários por meio de um ID do usuário. No caso do ` Instana `, trata-se de um objeto String transparente usado apenas para calcular determinadas métricas. userName e userEmail também podem ser usados para ter acesso a mais filtros e uma melhor apresentação das informações do usuário.

Nos casos em que você estiver lidando com usuários anônimos e, portanto, não tiver acesso a IDs de usuário, poderá usar IDs de sessão como alternativa. Os IDs de sessão não são tão úteis quanto os IDs de usuário na hora de filtrar dados, mas são um bom indicador para calcular métricas de usuários afetados ou únicos. Configure um nome de usuário como Anonymous para ter uma clara diferenciação entre usuários autenticados e não autenticados. Os IDs de sessão podem ser dados sensíveis (dependendo da estrutura ou plataforma usada). Considere aplicar um algoritmo de hash aos IDs de sessão para evitar a transmissão de dados para Instana que possam conceder acesso.

Os dados já enviados ao servidor da Instana não podem ser atualizados retroativamente. Por esse motivo, é importante chamar este ` API ` o mais cedo possível no processo de inicialização do aplicativo.

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

O código a seguir é uma definição de TypeScript:

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

É possível anexar metadados arbitrários a todos os dados transmitidos para Instana. Você pode usá-lo para rastrear valores de configuração da interface do usuário, definições, sinalizadores de recursos e qualquer contexto adicional que possa ser útil para análise.

static setMeta(String key, String value)

O código a seguir é uma definição de TypeScript:

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

Os eventos personalizados permitem enviar relatórios sobre atividades fora do padrão, interações importantes e intervalos de tempo personalizados para o Instana. Pode ser especialmente útil quando você está analisando erros não capturados (breadcrumbs) e para controlar mais métricas de desempenho.

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

O código a seguir é uma definição de TypeScript:

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

Os URLs podem ser ignorados fornecendo expressões regulares ou adicionando-os à lista ignoreURLs. Essa função é útil quando você deseja ignorar todas as solicitações do tipo ` HTTP ` que contenham dados confidenciais, como uma senha.

O agente precisa converter cada sequência de caracteres que você fornecer ao setIgnoreURLsByRegex método em uma expressão regular nativa para cada plataforma compatível. Você pode acompanhar as rejeições de promessas, que o informam sobre qualquer problema que o agente tenha encontrado enquanto você interpretava sua entrada.

static setIgnoreURLsByRegex([]String regexArray)

O código a seguir é uma definição de TypeScript:

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

Os parâmetros de consulta que estão nos URLs coletados podem conter dados confidenciais. Portanto, o agente Instana permite especificar padrões de expressão regular para chaves de parâmetros de consulta cujos valores precisam ser ocultados. Qualquer valor que precise ser redigido é substituído pela string <redacted>. A supressão ocorre no agente Instana antes de o agente enviar o relatório ao servidor Instana. Portanto, os segredos não chegam aos servidores do Instana para processamento e não estão disponíveis para análise na interface do usuário do Instana nem para recuperação por meio do Instana API.

Por padrão, o agente do Instana está configurado com uma lista de três padrões de expressão regular para ocultar automaticamente os valores dos parâmetros de consulta das chaves "password", "key" e "secret".

static setRedactHTTPQueryByRegex([]String regexArray)

O código a seguir é uma definição de TypeScript:

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

Opcionalmente, o agente Instana pode capturar os cabeçalhos HTTP de todas as solicitações e respostas rastreadas.

Uma lista de padrões regex pode ser definida para determinar quais cabeçalhos devem ser capturados.

Se o mesmo nome de cabeçalho estiver presente tanto em uma solicitação quanto em sua resposta, somente o valor do cabeçalho da resposta será considerado.

static setCaptureHeadersByRegex([]String regexArray)

O código a seguir é uma definição de TypeScript:

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

Por padrão, se o envio de um beacon falhar, o agente do Instana tenta reenviá-lo até que seja enviado com sucesso. No entanto, esse comportamento não funciona bem com algumas redes de celular. Ao ativar o recurso de modo de envio lento, você pode alterar o intervalo de envio do sinal para o valor de tempo atribuído ao slowSendInterval parâmetro. Cada envio consiste em apenas um indicador em vez de um lote (no máximo 100 indicadores em um lote). O agente do serviço de notificação de eventos ( Instana ) permanece no modo de envio lento até que um sinal de notificação seja enviado com sucesso.

O intervalo de tempo válido para o slowSendInterval parâmetro é de 2 a 3.600 segundos.

O código a seguir é uma definição de TypeScript:

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

Por padrão, a sessão do usuário é rastreada e um UUID (Universally Unique Identifier) é gerado aleatoriamente. Esse ID permanece inalterado enquanto o aplicativo está instalado. Você pode configurar o tempo de validade do ID da sessão do usuário usando o usiRefreshTimeIntervalInHrs parâmetro.

Os seguintes valores de parâmetro indicam o status do ID de sessão do usuário:

• Número negativo: Este valor indica que o ID de sessão do usuário nunca expira. O valor padrão é -1.

• Número positivo: Esse valor significa que a ID da sessão do usuário é atualizada após o tempo definido. Um novo UUID é gerado e usado.

• Zero: esse valor denotado por 0.0 significa que o ID de sessão do usuário está desativado..

O código a seguir é uma definição de TypeScript:

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

Com esse parâmetro, você pode personalizar os limites do número de beacons que podem ser enviados dentro de um intervalo de tempo específico. A tabela a seguir lista as opções disponíveis e os limites de baliza correspondentes. Por padrão, 0 (DEFAULT_LIMITS) está selecionado.

Quando a enableW3CHeaders opção ( Boolean , opcional) está ativada, o agente do React Native inclui os traceparenttracestate cabeçalhos e em todas as chamadas monitoradas do API. Esses cabeçalhos permitem a correlação do backend, mesmo que o backend não esteja equipado com o agente do Instana. Nesses casos, é necessário usar uma ferramenta de monitoramento compatível (como OpenTelemetry ) para exportar os detalhes do rastreamento do backend para o backend Instana. Se essa opção estiver desativada, a correlação do backend só será possível quando o backend também for monitorado pelo agente do Instana. O valor padrão é false.