_view_instrument_match.py

# 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.


from logging import getLogger
from threading import Lock
from typing import TYPE_CHECKING, Dict, Iterable

from opentelemetry.sdk._metrics.aggregation import (
    DefaultAggregation,
    _Aggregation,
    _AggregationFactory,
    _convert_aggregation_temporality,
    _PointVarT,
)
from opentelemetry.sdk._metrics.measurement import Measurement
from opentelemetry.sdk._metrics.point import AggregationTemporality, Metric
from opentelemetry.sdk._metrics.sdk_configuration import SdkConfiguration
from opentelemetry.sdk._metrics.view import View

if TYPE_CHECKING:
    from opentelemetry.sdk._metrics.instrument import _Instrument

_logger = getLogger(__name__)


class _ViewInstrumentMatch:
    def __init__(
        self,
        view: View,
        instrument: "_Instrument",
        sdk_config: SdkConfiguration,
        instrument_class_aggregation: Dict[type, _AggregationFactory],
    ):
        self._view = view
        self._instrument = instrument
        self._sdk_config = sdk_config
        self._attributes_aggregation: Dict[frozenset, _Aggregation] = {}
        self._attributes_previous_point: Dict[frozenset, _PointVarT] = {}
        self._lock = Lock()
        self._instrument_class_aggregation = instrument_class_aggregation

    # pylint: disable=protected-access
    def consume_measurement(self, measurement: Measurement) -> None:

        if self._view._attribute_keys is not None:

            attributes = {}

            for key, value in (measurement.attributes or {}).items():
                if key in self._view._attribute_keys:
                    attributes[key] = value
        elif measurement.attributes is not None:
            attributes = measurement.attributes
        else:
            attributes = {}

        attributes = frozenset(attributes.items())

        if attributes not in self._attributes_aggregation:
            with self._lock:
                if attributes not in self._attributes_aggregation:
                    if not isinstance(
                        self._view._aggregation, DefaultAggregation
                    ):
                        aggregation = (
                            self._view._aggregation._create_aggregation(
                                self._instrument
                            )
                        )
                    else:
                        aggregation = self._instrument_class_aggregation[
                            self._instrument.__class__
                        ]._create_aggregation(self._instrument)
                    self._attributes_aggregation[attributes] = aggregation

        self._attributes_aggregation[attributes].aggregate(measurement)

    def collect(
        self, instrument_class_temporality: Dict[type, AggregationTemporality]
    ) -> Iterable[Metric]:

        with self._lock:
            for (
                attributes,
                aggregation,
            ) in self._attributes_aggregation.items():

                previous_point = self._attributes_previous_point.get(
                    attributes
                )

                current_point = aggregation.collect()

                # pylint: disable=assignment-from-none
                self._attributes_previous_point[
                    attributes
                ] = _convert_aggregation_temporality(
                    previous_point,
                    current_point,
                    AggregationTemporality.CUMULATIVE,
                )

                if current_point is not None:

                    yield Metric(
                        attributes=dict(attributes),
                        description=(
                            self._view._description
                            or self._instrument.description
                        ),
                        instrumentation_scope=(
                            self._instrument.instrumentation_scope
                        ),
                        name=self._view._name or self._instrument.name,
                        resource=self._sdk_config.resource,
                        unit=self._instrument.unit,
                        point=_convert_aggregation_temporality(
                            previous_point,
                            current_point,
                            instrument_class_temporality[
                                self._instrument.__class__
                            ],
                        ),
                    )