Options
All
  • Public
  • Public/Protected
  • All
Menu

AppDynamics agent for react-native - API docs

Real user instrumentation for your react-native application.


This API documentation describes the JavaScript interface exposed by the agent. Installation instructions are provided in the package's README file. More information on AppDynamics Real User Monitoring is available on the documentation website.

Setup

Comprehensive setup instructions are provided in the package's README file.

Usage

The main API entry point for this module is the Instrumentation object. Bring it into scope with:

import { Instrumentation } from '@appdynamics/react-native-agent';

Copyright 2019 AppDynamics LLC and its affiliates.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Functions

InfoPoint

  • InfoPoint(target: unknown, propertyKey: string, descriptor: PropertyDescriptor): void
  • InfoPoint(manualData?: InfoPointData): function
  • Annotate methods you wish to be reported as InfoPoint to eum-cloud.

    Consider the following critical method which you wish to be reported as InfoPoint to eum-cloud.

    public infoPointMethod(arg1, arg2, value) {
        console.log("Executing infoPointMethod!");
    }

    Adding annotations to report info points automatically.

    For convenience purpose, you can simply annotate your methods without having to modify the code to manually report InfoPoints.

    @InfoPoint
    public infoPointMethod(arg1, arg2, value) {
        console.log("Executing infoPointMethod!");
    }

    Your method will automatically report info points to the eum cloud.

    Warning: If your code gets minified, the info point will report useless class and function names. You can either turn off minification for the annotated symbols, or you can manually specify the symbol names.

    To manually specify symbol names, pass a parameter to the InfoPoint decorator like this.

    @InfoPoint({ className: 'MyClass', fnName: 'infoPointMethod' })
    public infoPointMethod(arg1, arg2, value) {
        console.log("Executing infoPointMethod!");
    }

    Alternatively, you can exclude classes and functions from minification in the following way.

    • Install the npm package metro-minify-terser
    • Add this to your metro.config.js configuration file:
    transformer: {
     minifierPath: 'metro-minify-terser',
     minifierConfig: {
        // see: https://www.npmjs.com/package/terser
        keep_fnames: true,
        module: true
     }
    }
    see

    Instrumentation.trackCall

    Parameters

    • target: unknown
    • propertyKey: string
    • descriptor: PropertyDescriptor

    Returns void

  • Parameters

    • Optional manualData: InfoPointData

    Returns function

      • (target: unknown, propertyKey: string, descriptor: PropertyDescriptor): void
      • Parameters

        • target: unknown
        • propertyKey: string
        • descriptor: PropertyDescriptor

        Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc