File: meter_provider.h

package info (click to toggle)
opentelemetry-cpp 1.23.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 11,368 kB
  • sloc: cpp: 96,239; sh: 1,766; makefile: 38; python: 31
file content (148 lines) | stat: -rw-r--r-- 4,948 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

#pragma once

#include "opentelemetry/common/key_value_iterable.h"
#include "opentelemetry/common/key_value_iterable_view.h"
#include "opentelemetry/nostd/shared_ptr.h"
#include "opentelemetry/nostd/string_view.h"
#include "opentelemetry/nostd/type_traits.h"
#include "opentelemetry/version.h"

OPENTELEMETRY_BEGIN_NAMESPACE
namespace metrics
{

class Meter;

/**
 * Creates new Meter instances.
 */
class MeterProvider
{
public:
  virtual ~MeterProvider() = default;

#if OPENTELEMETRY_ABI_VERSION_NO >= 2

  /**
   * Gets or creates a named Meter instance (ABI).
   *
   * @since ABI_VERSION 2
   *
   * @param[in] name Meter instrumentation scope
   * @param[in] version Instrumentation scope version
   * @param[in] schema_url Instrumentation scope schema URL
   * @param[in] attributes Instrumentation scope attributes (optional, may be nullptr)
   */
  virtual nostd::shared_ptr<Meter> GetMeter(
      nostd::string_view name,
      nostd::string_view version,
      nostd::string_view schema_url,
      const common::KeyValueIterable *attributes) noexcept = 0;

  /**
   * Gets or creates a named Meter instance (API helper).
   *
   * @since ABI_VERSION 2
   *
   * @param[in] name Meter instrumentation scope
   * @param[in] version Instrumentation scope version, optional
   * @param[in] schema_url Instrumentation scope schema URL, optional
   */
  nostd::shared_ptr<Meter> GetMeter(nostd::string_view name,
                                    nostd::string_view version    = "",
                                    nostd::string_view schema_url = "")
  {
    return GetMeter(name, version, schema_url, nullptr);
  }

  /**
   * Gets or creates a named Meter instance (API helper).
   *
   * @since ABI_VERSION 2
   *
   * @param[in] name Meter instrumentation scope
   * @param[in] version Instrumentation scope version
   * @param[in] schema_url Instrumentation scope schema URL
   * @param[in] attributes Instrumentation scope attributes
   */
  nostd::shared_ptr<Meter> GetMeter(
      nostd::string_view name,
      nostd::string_view version,
      nostd::string_view schema_url,
      std::initializer_list<std::pair<nostd::string_view, common::AttributeValue>> attributes)
  {
    /* Build a container from std::initializer_list. */
    nostd::span<const std::pair<nostd::string_view, common::AttributeValue>> attributes_span{
        attributes.begin(), attributes.end()};

    /* Build a view on the container. */
    common::KeyValueIterableView<
        nostd::span<const std::pair<nostd::string_view, common::AttributeValue>>>
        iterable_attributes{attributes_span};

    /* Add attributes using the view. */
    return GetMeter(name, version, schema_url, &iterable_attributes);
  }

  /**
   * Gets or creates a named Meter instance (API helper).
   *
   * @since ABI_VERSION 2
   *
   * @param[in] name Meter instrumentation scope
   * @param[in] version Instrumentation scope version
   * @param[in] schema_url Instrumentation scope schema URL
   * @param[in] attributes Instrumentation scope attributes container
   */
  template <class T,
            nostd::enable_if_t<common::detail::is_key_value_iterable<T>::value> * = nullptr>
  nostd::shared_ptr<Meter> GetMeter(nostd::string_view name,
                                    nostd::string_view version,
                                    nostd::string_view schema_url,
                                    const T &attributes)
  {
    /* Build a view on the container. */
    common::KeyValueIterableView<T> iterable_attributes(attributes);

    /* Add attributes using the view. */
    return GetMeter(name, version, schema_url, &iterable_attributes);
  }

#else
  /**
   * Gets or creates a named Meter instance (ABI)
   *
   * @since ABI_VERSION 1
   *
   * @param[in] name Meter instrumentation scope
   * @param[in] version Instrumentation scope version, optional
   * @param[in] schema_url Instrumentation scope schema URL, optional
   */
  virtual nostd::shared_ptr<Meter> GetMeter(nostd::string_view name,
                                            nostd::string_view version    = "",
                                            nostd::string_view schema_url = "") noexcept = 0;
#endif

#if OPENTELEMETRY_ABI_VERSION_NO >= 2
  /**
   * Remove a named Meter instance (ABI).
   *
   * This API is experimental, see
   * https://github.com/open-telemetry/opentelemetry-specification/issues/2232
   *
   * @since ABI_VERSION 2
   *
   * @param[in] name Meter instrumentation scope
   * @param[in] version Instrumentation scope version, optional
   * @param[in] schema_url Instrumentation scope schema URL, optional
   */
  virtual void RemoveMeter(nostd::string_view name,
                           nostd::string_view version    = "",
                           nostd::string_view schema_url = "") noexcept = 0;
#endif
};
}  // namespace metrics
OPENTELEMETRY_END_NAMESPACE