Skip to main content

    App Environment

    Obtain the basic information about the app and the environment in which it's running.

    @dynatrace-sdk/app-environment
    v1.1.3
    npm install @dynatrace-sdk/app-environment

    Functions​

    getAppId​

    getAppId(): string

    Retrieves the app id.

    Returns​

    Return typeDescription
    string

    app id defined in app config.

    Note: If the Dynatrace JavaScript runtime isn't available, 'dt.missing.app.id' will be returned and a warning will be logged to the console.

    Code example

    import { getAppId } from '@dynatrace-sdk/platform/app-environment';

    // Get the current app's ID
    const appId = getAppId();

    getAppName​

    getAppName(): string

    Retrieves the app name.

    Returns​

    Return typeDescription
    string

    app name defined in app config.

    Note: If the Dynatrace JavaScript runtime isn't available, 'dt.missing.app.name' will be returned and a warning will be logged to the console.

    Code example

    import { getAppName } from '@dynatrace-sdk/platform/app-environment';

    // Get the current app's name
    const appName = getAppName();

    getAppVersion​

    getAppVersion(): string

    Retrieves the app version.

    Returns​

    Return typeDescription
    string

    app version defined in app manifest.

    Note: If the Dynatrace JavaScript runtime isn't available, 'dt.missing.app.version' will be returned and a warning will be logged to the console.

    Code example

    import { getAppVersion } from '@dynatrace-sdk/platform/app-environment';

    // Get the current app's version
    const appVersion = getAppVersion();

    getCurrentUserDetails​

    getCurrentUserDetails(): UserDetails

    Retrieves the information about currently logged user

    Returns​

    Return typeDescription
    UserDetails

    id, name and email of currently logged user.

    Note: If the Dynatrace JavaScript runtime isn't available, a default UserDetails placeholder object with values ('dt.missing.user.id', 'dt.missing.user.name', 'dt.missing.user.email') will be returned and a warning will be logged to the console.

    Code example

    import { getCurrentUserDetails } from '@dynatrace-sdk/platform/app-environment';

    // Get the details of the currently logged-in user
    const userDetails = getCurrentUserDetails();

    // Use destructuring to extract specific properties
    const { id, name, email } = getCurrentUserDetails();

    getEnvironmentId​

    getEnvironmentId(): string

    Retrieves the environment id.

    Returns​

    Return typeDescription
    string

    environment id on which app is run.

    Note: If the Dynatrace JavaScript runtime isn't available, 'dt.missing.environment.id' will be returned and a warning will be logged to the console.

    Code example

    import { getEnvironmentId } from '@dynatrace-sdk/platform/app-environment';

    // Get the current environment ID
    const environmentId = getEnvironmentId();

    getEnvironmentUrl​

    getEnvironmentUrl(): string

    Retrieves the environment url.

    Returns​

    Return typeDescription
    string

    environment url on which app is run.

    Note: If the Dynatrace JavaScript runtime isn't available, 'https://dynatrace.com/' will be returned and a warning will be logged to the console.

    Code example

    import { getEnvironmentUrl } from '@dynatrace-sdk/platform/app-environment';

    // Get the current environment URL
    const environmentUrl = getEnvironmentUrl();

    Types​

    UserDetails​

    Information about currently logged user

    Properties​

    NameType
    email*requiredstring
    id*requiredstring
    name*requiredstring
    Still have questions?
    Find answers in the Dynatrace Community