includes/opentelemetry/sdk/instrumentationscope/instrumentation_scope.h

Go to the documentation of this file.

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
 
#pragma once
 
#include <string>
#include <type_traits>
 
#include "opentelemetry/common/key_value_iterable_view.h"
#include "opentelemetry/nostd/string_view.h"
#include "opentelemetry/nostd/type_traits.h"
#include "opentelemetry/nostd/unique_ptr.h"
#include "opentelemetry/nostd/variant.h"
#include "opentelemetry/sdk/common/attribute_utils.h"
#include "opentelemetry/version.h"
 
OPENTELEMETRY_BEGIN_NAMESPACE
 
namespace sdk
{
namespace instrumentationscope
{
 
using InstrumentationScopeAttributes = opentelemetry::sdk::common::AttributeMap;
 
class InstrumentationScope
{
public:
  InstrumentationScope(const InstrumentationScope &) = default;
 
  static nostd::unique_ptr<InstrumentationScope> Create(
      nostd::string_view name,
      nostd::string_view version                  = "",
      nostd::string_view schema_url               = "",
      InstrumentationScopeAttributes &&attributes = {})
  {
    return nostd::unique_ptr<InstrumentationScope>(
        new InstrumentationScope{name, version, schema_url, std::move(attributes)});
  }
 
  static nostd::unique_ptr<InstrumentationScope> Create(
      nostd::string_view name,
      nostd::string_view version,
      nostd::string_view schema_url,
      const InstrumentationScopeAttributes &attributes)
  {
    return nostd::unique_ptr<InstrumentationScope>(new InstrumentationScope{
        name, version, schema_url, InstrumentationScopeAttributes(attributes)});
  }
 
  template <
      class ArgumentType,
      nostd::enable_if_t<opentelemetry::common::detail::is_key_value_iterable<ArgumentType>::value>
          * = nullptr>
  static nostd::unique_ptr<InstrumentationScope> Create(nostd::string_view name,
                                                        nostd::string_view version,
                                                        nostd::string_view schema_url,
                                                        const ArgumentType &arg)
  {
    nostd::unique_ptr<InstrumentationScope> result = nostd::unique_ptr<InstrumentationScope>(
        new InstrumentationScope{name, version, schema_url});
 
    // Do not construct a KeyValueIterable, so it has better performance.
    result->attributes_.reserve(opentelemetry::nostd::size(arg));
    for (auto &argv : arg)
    {
      result->SetAttribute(argv.first, argv.second);
    }
 
    return result;
  }
 
  std::size_t HashCode() const noexcept { return hash_code_; }
 
  bool operator==(const InstrumentationScope &other) const noexcept
  {
    return this->name_ == other.name_ && this->version_ == other.version_ &&
           this->schema_url_ == other.schema_url_ && this->attributes_ == other.attributes_;
  }
 
  bool equal(const nostd::string_view name,
             const nostd::string_view version,
             const nostd::string_view schema_url                       = "",
             const opentelemetry::common::KeyValueIterable *attributes = nullptr) const noexcept
  {
 
    if (this->name_ != name || this->version_ != version || this->schema_url_ != schema_url)
    {
      return false;
    }
 
    if (attributes == nullptr)
    {
      if (attributes_.empty())
      {
        return true;
      }
      return false;
    }
 
    return attributes_.EqualTo(*attributes);
  }
 
  const std::string &GetName() const noexcept { return name_; }
  const std::string &GetVersion() const noexcept { return version_; }
  const std::string &GetSchemaURL() const noexcept { return schema_url_; }
  const InstrumentationScopeAttributes &GetAttributes() const noexcept { return attributes_; }
 
  void SetAttribute(nostd::string_view key,
                    const opentelemetry::common::AttributeValue &value) noexcept
  {
    attributes_[std::string(key)] =
        nostd::visit(opentelemetry::sdk::common::AttributeConverter(), value);
  }
 
private:
  InstrumentationScope(nostd::string_view name,
                       nostd::string_view version,
                       nostd::string_view schema_url               = "",
                       InstrumentationScopeAttributes &&attributes = {})
      : name_(name), version_(version), schema_url_(schema_url), attributes_(std::move(attributes))
  {
    std::string hash_data;
    hash_data.reserve(name_.size() + version_.size() + schema_url_.size());
    hash_data += name_;
    hash_data += version_;
    hash_data += schema_url_;
    hash_code_ = std::hash<std::string>{}(hash_data);
  }
 
private:
  std::string name_;
  std::string version_;
  std::string schema_url_;
  std::size_t hash_code_;
 
  InstrumentationScopeAttributes attributes_;
};
 
}  // namespace instrumentationscope
}  // namespace sdk
 
OPENTELEMETRY_END_NAMESPACE