attributes.rb

# frozen_string_literal: true

# Copyright The OpenTelemetry Authors
#
# 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.
#
# SPDX-License-Identifier: Apache-2.0
#
# This file was autogenerated. Do not edit it by hand.

module OpenTelemetry
  module SemConv
    module Incubating
      module APP
        # @!group Attribute Names

        # Unique identifier for a particular build or compilation of the application.
        #
        # @note Stability Level: development
        APP_BUILD_ID = 'app.build_id'

        # A unique identifier representing an instance of an end-user facing app crash.
        #
        # Its value MAY be meaningful and be used as a reference for telemetry and metadata recorded by
        # the same instrumentation (e.g. it is an ID generated by an external source that captured the crash).
        # It MAY come from a source external to the instrumentation such that it can be used to look up additional
        # data from other sources as well as facilitate deduplication.
        #
        # @note Stability Level: development
        APP_CRASH_ID = 'app.crash.id'

        # A unique identifier representing the installation of an application on a specific device
        #
        # Its value SHOULD persist across launches of the same application installation, including through application upgrades.
        # It SHOULD change if the application is uninstalled or if all applications of the vendor are uninstalled.
        # Additionally, users might be able to reset this value (e.g. by clearing application data).
        # If an app is installed multiple times on the same device (e.g. in different accounts on Android), each `app.installation.id` SHOULD have a different value.
        # If multiple OpenTelemetry SDKs are used within the same application, they SHOULD use the same value for `app.installation.id`.
        # Hardware IDs (e.g. serial number, IMEI, MAC address) MUST NOT be used as the `app.installation.id`.
        #
        # For iOS, this value SHOULD be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/identifierforvendor).
        #
        # For Android, examples of `app.installation.id` implementations include:
        #
        # - [Firebase Installation ID](https://firebase.google.com/docs/projects/manage-installations).
        # - A globally unique UUID which is persisted across sessions in your application.
        # - [App set ID](https://developer.android.com/identity/app-set-id).
        # - [`Settings.getString(Settings.Secure.ANDROID_ID)`](https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID).
        #
        # More information about Android identifier best practices can be found in the [Android user data IDs guide](https://developer.android.com/training/articles/user-data-ids).
        #
        # @note Stability Level: development
        APP_INSTALLATION_ID = 'app.installation.id'

        # A number of frame renders that experienced jank.
        #
        # Depending on platform limitations, the value provided MAY be approximation.
        #
        # @note Stability Level: development
        APP_JANK_FRAME_COUNT = 'app.jank.frame_count'

        # The time period, in seconds, for which this jank is being reported.
        #
        # @note Stability Level: development
        APP_JANK_PERIOD = 'app.jank.period'

        # The minimum rendering threshold for this jank, in seconds.
        #
        # @note Stability Level: development
        APP_JANK_THRESHOLD = 'app.jank.threshold'

        # The x (horizontal) coordinate of a screen coordinate, in screen pixels.
        #
        # @note Stability Level: development
        APP_SCREEN_COORDINATE_X = 'app.screen.coordinate.x'

        # The y (vertical) component of a screen coordinate, in screen pixels.
        #
        # @note Stability Level: development
        APP_SCREEN_COORDINATE_Y = 'app.screen.coordinate.y'

        # An identifier that uniquely differentiates this screen from other screens in the same application.
        #
        # A screen represents only the part of the device display drawn by the app. It typically contains multiple widgets or UI components and is larger in scope than individual widgets. Multiple screens can coexist on the same display simultaneously (e.g., split view on tablets).
        #
        # @note Stability Level: development
        APP_SCREEN_ID = 'app.screen.id'

        # The name of an application screen.
        #
        # A screen represents only the part of the device display drawn by the app. It typically contains multiple widgets or UI components and is larger in scope than individual widgets. Multiple screens can coexist on the same display simultaneously (e.g., split view on tablets).
        #
        # @note Stability Level: development
        APP_SCREEN_NAME = 'app.screen.name'

        # An identifier that uniquely differentiates this widget from other widgets in the same application.
        #
        # A widget is an application component, typically an on-screen visual GUI element.
        #
        # @note Stability Level: development
        APP_WIDGET_ID = 'app.widget.id'

        # The name of an application widget.
        #
        # A widget is an application component, typically an on-screen visual GUI element.
        #
        # @note Stability Level: development
        APP_WIDGET_NAME = 'app.widget.name'

        # @!endgroup
      end
    end
  end
end