provider.h

Go to the documentation of this file.

/*
 * Copyright 2026 The A11 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.
 */
 
#ifndef A11_OBS_PROVIDER_H_
#define A11_OBS_PROVIDER_H_
 
#include <string>
#include <utility>
#include <vector>
 
#include <absl/status/status.h>
 
#include "a11/obs/span.h"
 
namespace a11::obs {
 
enum class ExporterKind {
  kNone,      
  kInMemory,  
  kOstream,   
  kOtlpHttp,
};
 
struct ProviderOptions {
  std::string service_name = "a11";  
  std::vector<std::pair<std::string, std::string>> resource_attributes;
  ExporterKind exporter = ExporterKind::kNone;
  // Simple (synchronous) processing exports each span as it ends -- convenient
  // and deterministic for tests. Batch processing is used otherwise.
  bool use_simple_processor = false;  
 
  // OTLP/HTTP options (only used when exporter == kOtlpHttp).
  std::string otlp_endpoint;  
  std::vector<std::pair<std::string, std::string>> otlp_headers;
  int otlp_timeout_millis = 10000;  
 
  // Baggage keys promoted onto every span as attributes (of the same name).
  std::vector<std::string> baggage_span_attributes;
};
 
absl::Status Configure(const ProviderOptions& options);
 
void Shutdown();
 
[[nodiscard]] bool IsConfigured();
 
// --- Introspection (meaningful only with ExporterKind::kInMemory) ---------
 
struct RecordedEvent {
  std::string name;  
  std::vector<std::pair<std::string, std::string>>
      attributes;  
};
 
struct RecordedSpan {
  std::string name;            
  std::string trace_id;        
  std::string span_id;         
  std::string parent_span_id;  
  SpanKind kind = SpanKind::kInternal;  
  int status_code = 0;             
  std::string status_description;  
  std::vector<std::pair<std::string, std::string>>
      attributes;                     
  std::vector<RecordedEvent> events;  
};
 
std::vector<RecordedSpan> GetRecordedSpans();
 
void ClearRecordedSpans();
 
}  // namespace a11::obs
 
#endif  // A11_OBS_PROVIDER_H_