Merge pull request #50 from r-lib/apiv2

Author: gaborcsardi

DESCRIPTION

@@ -38,7 +38,7 @@ Suggests:
     webfakes,
     withr
 Remotes:
-    r-lib/otel
+    r-lib/otel@apiv2
 Config/testthat/edition: 3
 URL: https://otelsdk.r-lib.org, https://github.com/r-lib/otelsdk
 Config/Needs/website: tidyverse/tidytemplate

R/span.R

@@ -4,8 +4,8 @@ span_new <- function(
   attributes = NULL,
   links = NULL,
   options = NULL,
-  scope = parent.frame(),
-  activation_scope = parent.frame()
+  scope = NULL,
+  activation_scope = NULL
 ) {
   name <- name %||% default_span_name
   name <- as_string(name)
@@ -117,9 +117,19 @@ span_new <- function(
       invisible(self)
     },
 
-    activate = function(activation_scope = parent.frame()) {
+    activate = function(
+      activation_scope = parent.frame(),
+      end_on_exit = FALSE
+    ) {
+      force(end_on_exit)
       cscope <- ccall(otel_scope_start, self$xptr)
-      defer(ccall(otel_scope_end, cscope), envir = activation_scope)
+      defer(
+        {
+          ccall(otel_scope_end, cscope)
+          if (end_on_exit) self$end(status_code = "auto")
+        },
+        envir = activation_scope
+      )
     },
 
     name = NULL

R/tracer.R

@@ -16,6 +16,22 @@ tracer_new <- function(
   self <- new_object(
     "otel_tracer",
     start_span = function(
+      name = NULL,
+      attributes = NULL,
+      links = NULL,
+      options = NULL
+    ) {
+      span_new(
+        self,
+        name = name,
+        attributes = attributes,
+        links = links,
+        options = options,
+        scope = NULL,
+        activation_scope = NULL
+      )
+    },
+    start_local_active_span = function(
       name = NULL,
       attributes = NULL,
       links = NULL,

man/otelsdk-package.Rd

@@ -120,7 +120,7 @@ test_that("span_context", {
   expect_true(any(grepl("trace_id\\s*:\\s*0{32}", lns)))
   expect_true(any(grepl("span_id\\s*:\\s*0{16}", lns)))
 
-  sp1 <- trc$start_span("s")
+  sp1 <- trc$start_local_active_span("s")
   lgr$info("span context test")
   lp$flush()
   sp1$end()
@@ -133,7 +133,7 @@ test_that("span_context", {
   )))
   expect_true(any(grepl(paste0("span_id\\s*:\\s*", spns[["s"]]$span_id), lns)))
 
-  sp2 <- trc$start_span("s2")
+  sp2 <- trc$start_local_active_span("s2")
   lgr$info("span context test", span_context = sp2)
   lgr$flush()
   sp2$end()

tests/testthat/test-logger.R

@@ -53,7 +53,7 @@ test_that("format.otel_attributes", {
 
 test_that("format.otel_span_data, print.otel_span_data", {
   spns <- with_otel_record(function() {
-    otel::start_span("s", tracer = "org.r-lib.otel")
+    otel::start_local_active_span("s", tracer = "org.r-lib.otel")
     trc <- otel::get_tracer("org.r-lib.otel")
   })[["traces"]]
 
@@ -65,7 +65,7 @@ test_that("format.otel_span_data, print.otel_span_data", {
 
 test_that("format.otel_instrumentation_scope_data", {
   spns <- with_otel_record(function() {
-    otel::start_span("s", tracer = "org.r-lib.otel")
+    otel::start_local_active_span("s", tracer = "org.r-lib.otel")
     trc <- otel::get_tracer("org.r-lib.otel")
   })[["traces"]]
 
@@ -80,7 +80,7 @@ test_that("format.otel_instrumentation_scope_data", {
     schema_url = "https://opentelemetry.io/schemas/1.13.0",
     attributes = list(foo = 1:5, bar = "that")
   )
-  sp <- trc$start_span("s")
+  sp <- trc$start_local_active_span("s")
   sp$end()
   spns <- tp$get_spans()
 

tests/testthat/test-print.R

@@ -8,40 +8,41 @@ test_that("sessions auto-close", {
   }
 
   serial2 <- function() {
-    otel::start_span("serial2")
+    otel::start_local_active_span("serial2")
   }
 
   serial <- function() {
-    ser <- otel::start_span("serial")
+    ser <- otel::start_local_active_span("serial")
     serial2()
   }
 
   start_sess <- function() {
     opts <- new.env(parent = emptyenv())
-    opts$otel_session <- otel::start_span("sess", scope = NULL)
-    s1 <- otel::start_span("1")
+    opts$otel_session <- otel::start_span("sess")
+    otel::local_active_span(opts$otel_session)
+    s1 <- otel::start_local_active_span("1")
     opts
   }
 
   work_sess <- function(opts) {
     opts$otel_session$activate()
-    sp2 <- otel::start_span("2")
+    sp2 <- otel::start_local_active_span("2")
     serial()
   }
 
   end_sess <- function(opts) {
     opts$otel_session$activate()
-    sp3 <- otel::start_span("3")
+    sp3 <- otel::start_local_active_span("3")
     opts$otel_session$end()
   }
 
   spns <- with_otel_record({
     fun <- function() {
-      spn0 <- otel::start_span("0")
+      spn0 <- otel::start_local_active_span("0")
       opts <- start_sess()
-      spn01 <- otel::start_span("01")
+      spn01 <- otel::start_local_active_span("01")
       work_sess(opts)
-      spn02 <- otel::start_span("02")
+      spn02 <- otel::start_local_active_span("02")
       end_sess(opts)
     }
     fun()
@@ -72,40 +73,41 @@ test_that("sessions, suggested practices", {
   }
 
   serial2 <- function() {
-    otel::start_span("serial2")
+    otel::start_local_active_span("serial2")
   }
 
   serial <- function() {
-    ser <- otel::start_span("serial")
+    ser <- otel::start_local_active_span("serial")
     serial2()
   }
 
   start_sess <- function() {
     opts <- new.env(parent = emptyenv())
-    opts$otel_session <- otel::start_span("sess", scope = NULL)
-    s1 <- otel::start_span("1")
+    opts$otel_session <- otel::start_span("sess")
+    otel::local_active_span(opts$otel_session)
+    s1 <- otel::start_local_active_span("1")
     opts
   }
 
   work_sess <- function(opts) {
     otel::local_active_span(opts$otel_session)
-    sp2 <- otel::start_span("2")
+    sp2 <- otel::start_local_active_span("2")
     serial()
   }
 
   end_sess <- function(opts) {
     otel::local_active_span(opts$otel_session)
-    sp3 <- otel::start_span("3")
+    sp3 <- otel::start_local_active_span("3")
     opts$otel_session$end()
   }
 
   spns <- with_otel_record({
     fun <- function() {
-      spn0 <- otel::start_span("0")
+      spn0 <- otel::start_local_active_span("0")
       opts <- start_sess()
-      spn01 <- otel::start_span("01")
+      spn01 <- otel::start_local_active_span("01")
       work_sess(opts)
-      spn02 <- otel::start_span("02")
+      spn02 <- otel::start_local_active_span("02")
       end_sess(opts)
     }
     fun()
@@ -128,13 +130,14 @@ test_that("sessions, suggested practices", {
 
 test_that("nested sessions", {
   create_inner_span <- function(name, tracer) {
-    tracer$start_span(name, scope = NULL)
+    tracer$start_span(name)
   }
 
   spans <- otelsdk::with_otel_record({
     trc <- otel::get_tracer("test")
 
-    outer <- trc$start_span("outer", scope = NULL, options = list(parent = NA))
+    outer <- trc$start_span("outer", options = list(parent = NA))
+    otel::local_active_span(outer)
 
     # Emulate two "concurrent" operations that create session spans.
     inner1 <- create_inner_span("inner1", trc)

tests/testthat/test-sessions.R

@@ -1,8 +1,8 @@
 test_that("named and unnamed spans", {
   spns <- with_otel_record({
     trc <- otel::get_tracer("mytracer")
-    spn1 <- trc$start_span()
-    spn2 <- trc$start_span("my")
+    spn1 <- trc$start_local_active_span()
+    spn2 <- trc$start_local_active_span("my")
     spn2$end()
     spn1$end()
   })[["traces"]]
@@ -15,7 +15,7 @@ test_that("close span automatically", {
   spns <- with_otel_record({
     trc <- otel::get_tracer("mytracer")
     do <- function(name = NULL) {
-      spn1 <- trc$start_span(name)
+      spn1 <- trc$start_local_active_span(name)
     }
     do("1")
     do("2")
@@ -32,7 +32,7 @@ test_that("close span automatically, on error", {
   spns <- with_otel_record({
     trc <- otel::get_tracer("mytracer")
     do <- function(name = NULL) {
-      spn1 <- trc$start_span(name)
+      spn1 <- trc$start_local_active_span(name)
       stop("oops")
     }
     try(do("1"), silent = TRUE)
@@ -49,15 +49,15 @@ test_that("close span automatically, on error", {
 test_that("is_recording", {
   trc_prv <- tracer_provider_memory_new()
   trc <- trc_prv$get_tracer("mytracer")
-  spn1 <- trc$start_span()
+  spn1 <- trc$start_local_active_span()
   expect_true(spn1$is_recording())
 })
 
 test_that("set_attribute", {
   spns <- with_otel_record({
     trc <- otel::get_tracer("mytracer")
-    spn1 <- trc$start_span()
-    spn2 <- trc$start_span("my")
+    spn1 <- trc$start_local_active_span()
+    spn2 <- trc$start_local_active_span("my")
     spn2$set_attribute("key", letters[1:3])
     spn1$set_attribute("key", "gone")
     spn2$end()
@@ -78,8 +78,8 @@ test_that("set_attribute", {
 test_that("add_event", {
   spns <- with_otel_record({
     trc <- otel::get_tracer("mytracer")
-    spn1 <- trc$start_span()
-    spn2 <- trc$start_span("my")
+    spn1 <- trc$start_local_active_span()
+    spn2 <- trc$start_local_active_span("my")
     spn2$add_event("ev", attributes = list(key = "value", key2 = 1:5))
     spn2$add_event("ev2", attributes = list(x = letters[1:4]))
     spn2$end()
@@ -103,7 +103,7 @@ test_that("set_status", {
   spns <- with_otel_record({
     trc <- otel::get_tracer("mytracer")
     do <- function() {
-      spn1 <- trc$start_span()
+      spn1 <- trc$start_local_active_span()
       spn1$set_status("Unset", description = "Testing preset Unset")
     }
     do()
@@ -117,7 +117,7 @@ test_that("set_status", {
 test_that("update_name", {
   spns <- with_otel_record({
     trc <- otel::get_tracer("mytracer")
-    spn1 <- trc$start_span()
+    spn1 <- trc$start_local_active_span()
     spn1$update_name("good")
     spn1$end()
   })[["traces"]]
@@ -131,7 +131,7 @@ test_that("record_exception", {
   error_obj <- base_error()
   spns <- with_otel_record({
     trc <- otel::get_tracer("mytracer")
-    spn1 <- trc$start_span()
+    spn1 <- trc$start_local_active_span()
     spn1$record_exception(error_obj)
     spn1$end()
   })[["traces"]]
@@ -173,8 +173,8 @@ test_that("format_exception", {
 test_that("create a root span", {
   spns <- with_otel_record({
     trc <- otel::get_tracer("mytracer")
-    spn1 <- trc$start_span("1")
-    spn2 <- trc$start_span("2", options = list(parent = NA))
+    spn1 <- trc$start_local_active_span("1")
+    spn2 <- trc$start_local_active_span("2", options = list(parent = NA))
     spn2$end()
     spn1$end()
   })[["traces"]]
@@ -188,7 +188,7 @@ test_that("get_context", {
   spid1 <- spid2 <- NULL
   spns <- with_otel_record(function() {
     trc <- otel::get_tracer()
-    spn <- trc$start_span("1")
+    spn <- trc$start_local_active_span("1")
     spid1 <<- spn$get_context()$get_span_id()
     spid2 <<- trc$get_active_span_context()$get_span_id()
   })[["traces"]]
@@ -202,15 +202,15 @@ test_that("get_context", {
 test_that("is_valid", {
   spns <- with_otel_record(function() {
     trc <- otel::get_tracer()
-    spn <- trc$start_span("1")
+    spn <- trc$start_local_active_span("1")
     expect_true(spn$is_valid())
   })[["traces"]]
 })
 
 test_that("span_context", {
   spns <- with_otel_record(function() {
     trc <- otel::get_tracer()
-    spn <- trc$start_span("1")
+    spn <- trc$start_local_active_span("1")
     ctx <- spn$get_context()
     expect_true(ctx$is_valid())
     expect_snapshot(ctx$get_trace_flags())

tests/testthat/test-span.R

@@ -7,7 +7,7 @@ test_that("tracer_provider_file", {
 
   tp <- tracer_provider_file_new()
   trc <- tp$get_tracer()
-  sp1 <- trc$start_span("s1")
+  sp1 <- trc$start_local_active_span("s1")
   sp1$end()
   tp$flush()
 

tests/testthat/test-tracer-provider-file.R

@@ -9,7 +9,7 @@ test_that("writing to a file", {
   on.exit(unlink(tmp), add = TRUE)
   tp <- tracer_provider_stdstream_new(list(output = tmp))
   trc <- tp$get_tracer()
-  sp1 <- trc$start_span("testspan")
+  sp1 <- trc$start_local_active_span("testspan")
   sp1$end()
   tp$flush()