Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement synchronous gauge APIs for Double and Long types #670

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion Examples/Stable Metric Sample/main.swift
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,13 @@ basicConfiguration()

// creating a new meter & instrument
let meter = OpenTelemetry.instance.stableMeterProvider?.meterBuilder(name: "MyMeter").build()
var gaugeBuilder = meter!.gaugeBuilder(name: "Gauge").buildWithCallback({ ObservableDoubleMeasurement in
var gaugeBuilder = meter!.gaugeBuilder(name: "Gauge")

// observable gauge
var observableGauge = gaugeBuilder.buildWithCallback({ ObservableDoubleMeasurement in
ObservableDoubleMeasurement.record(value: 1.0, attributes: ["test": AttributeValue.bool(true)])
})

// gauge
var gauge = gaugeBuilder.build()
gauge.record(value: 1.0, attributes: ["test": AttributeValue.bool(true)])
Original file line number Diff line number Diff line change
Expand Up @@ -54,17 +54,37 @@ public class DefaultStableMeter: StableMeter {
NoopLongGaugeBuilder()
}

func build() -> DoubleGauge {
NoopDoubleGauge()
}

func buildWithCallback(_ callback: @escaping (ObservableDoubleMeasurement) -> Void) -> ObservableDoubleGauge {
NoopObservableDoubleGauge()
}
}

private class NoopLongGaugeBuilder: LongGaugeBuilder {
private class NoopLongGaugeBuilder: LongGaugeBuilder {
func build() -> LongGauge {
NoopLongGauge()
}

func buildWithCallback(_ callback: @escaping (ObservableLongMeasurement) -> Void) -> ObservableLongGauge {
NoopObservableLongGauge()
}
}

private struct NoopDoubleGauge: DoubleGauge {
func record(value: Double) {}

func record(value: Double, attributes: [String : AttributeValue]) {}
}

private struct NoopLongGauge: LongGauge {
func record(value: Int) {}

func record(value: Int, attributes: [String : AttributeValue]) {}
}

private struct NoopObservableLongGauge: ObservableLongGauge {
func close() {}
}
Expand Down
11 changes: 11 additions & 0 deletions Sources/OpenTelemetryApi/Metrics/Stable/DoubleGauge.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
//
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
//

import Foundation

public protocol DoubleGauge {
mutating func record(value: Double)
mutating func record(value: Double, attributes: [String: AttributeValue])
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ import Foundation

public protocol DoubleGaugeBuilder: AnyObject {
func ofLongs() -> LongGaugeBuilder
func build() -> DoubleGauge
func buildWithCallback(_ callback: @escaping (ObservableDoubleMeasurement) -> Void) -> ObservableDoubleGauge
}
11 changes: 11 additions & 0 deletions Sources/OpenTelemetryApi/Metrics/Stable/LongGauge.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
//
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
//

import Foundation

public protocol LongGauge {
mutating func record(value: Int)
mutating func record(value: Int, attributes: [String: AttributeValue])
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@
import Foundation

public protocol LongGaugeBuilder: AnyObject {
func build() -> LongGauge
func buildWithCallback(_ callback: @escaping (ObservableLongMeasurement) -> Void) -> ObservableLongGauge
}
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ public class DoubleGaugeBuilderSdk: DoubleGaugeBuilder, InstrumentBuilder {
swapBuilder(LongGaugeBuilderSdk.init)
}

public func build() -> DoubleGauge {
return buildSynchronousInstrument(DoubleGaugeSdk.init)
}

public func buildWithCallback(_ callback: @escaping (OpenTelemetryApi.ObservableDoubleMeasurement) -> Void) -> OpenTelemetryApi.ObservableDoubleGauge {
registerDoubleAsynchronousInstrument(type: type, updater: callback)
}
Expand Down
26 changes: 26 additions & 0 deletions Sources/OpenTelemetrySdk/Metrics/Stable/DoubleGaugeSdk.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
//
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
//

import Foundation
import OpenTelemetryApi

public class DoubleGaugeSdk: DoubleGauge, Instrument {

public var instrumentDescriptor: InstrumentDescriptor
private var storage: WritableMetricStorage

init(descriptor: InstrumentDescriptor, storage: WritableMetricStorage) {
self.storage = storage
self.instrumentDescriptor = descriptor
}

public func record(value: Double) {
record(value: value, attributes: [String: AttributeValue]())
}

public func record(value: Double, attributes: [String : OpenTelemetryApi.AttributeValue]) {
storage.recordDouble(value: value, attributes: attributes)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import Foundation
import OpenTelemetryApi

public class LongGaugeBuilderSdk: LongGaugeBuilder, InstrumentBuilder {

var meterProviderSharedState: MeterProviderSharedState
Expand All @@ -29,6 +30,10 @@ public class LongGaugeBuilderSdk: LongGaugeBuilder, InstrumentBuilder {
self.meterProviderSharedState = meterProviderSharedState
}

public func build() -> OpenTelemetryApi.LongGauge {
return buildSynchronousInstrument(LongGaugeSdk.init)
}

public func buildWithCallback(_ callback: @escaping (OpenTelemetryApi.ObservableLongMeasurement) -> Void) -> OpenTelemetryApi.ObservableLongGauge {
registerLongAsynchronousInstrument(type: type, updater: callback)
}
Expand Down
27 changes: 27 additions & 0 deletions Sources/OpenTelemetrySdk/Metrics/Stable/LongGaugeSdk.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
//
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
//

import Foundation
import OpenTelemetryApi

public class LongGaugeSdk: LongGauge, Instrument {

public var instrumentDescriptor: InstrumentDescriptor
private var storage: WritableMetricStorage

init(descriptor: InstrumentDescriptor, storage: WritableMetricStorage) {
self.storage = storage
self.instrumentDescriptor = descriptor
}

public func record(value: Int) {
record(value: value, attributes: [String: AttributeValue]())
}

public func record(value: Int, attributes: [String: OpenTelemetryApi.AttributeValue]) {
storage.recordLong(value: value, attributes: attributes)
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ class BuilderTests : XCTestCase {
XCTAssertTrue(type(of:meter) == DefaultStableMeter.self)
XCTAssertNotNil(meter.counterBuilder(name: "counter").ofDoubles().build())
XCTAssertNotNil(meter.counterBuilder(name: "counter").build())
XCTAssertNotNil(meter.gaugeBuilder(name: "gauge").build())
XCTAssertNotNil(meter.gaugeBuilder(name: "gauge").buildWithCallback({ _ in }))
XCTAssertNotNil(meter.gaugeBuilder(name: "gauge").ofLongs().build())
XCTAssertNotNil(meter.gaugeBuilder(name: "gauge").ofLongs().buildWithCallback({ _ in }))
XCTAssertNotNil(meter.histogramBuilder(name: "histogram").build())
XCTAssertNotNil(meter.histogramBuilder(name: "histogram").ofLongs().build())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,20 @@ class StableMeterProviderTests : XCTestCase {

var counter = meterSdk.counterBuilder(name: "counter").build()

var _ = meterSdk.gaugeBuilder(name: "gauge").buildWithCallback { measurement in
var _ = meterSdk.gaugeBuilder(name: "observable_gauge").buildWithCallback { measurement in
measurement.record(value: 1.0)
}
var histogram = meterSdk.histogramBuilder(name: "histogram").build()
var upDown = meterSdk.upDownCounterBuilder(name: "upDown").build()


var doubleGauge = meterSdk.gaugeBuilder(name: "double_gauge").build()
doubleGauge.record(value: 5.0)

var longGauge = meterSdk.gaugeBuilder(name: "long_gauge").ofLongs().build()
longGauge.record(value: 10)

counter.add(value: 1)
// histogram.record(value: 2.0)
histogram.record(value: 2.0)
upDown.add(value: 100)

let metrics = mockExporter.waitForExport()
Expand All @@ -56,7 +62,16 @@ class StableMeterProviderTests : XCTestCase {
metric.name == "counter" && (metric.data.points[0] as! LongPointData).value == 1
}))
XCTAssertTrue(metrics.contains(where: { metric in
metric.name == "gauge" && (metric.data.points[0] as! DoublePointData).value == 1.0
metric.name == "observable_gauge" && (metric.data.points[0] as! DoublePointData).value == 1.0
}))
XCTAssertTrue(metrics.contains(where: { metric in
metric.name == "double_gauge" && (metric.data.points[0] as! DoublePointData).value == 5.0
}))
XCTAssertTrue(metrics.contains(where: { metric in
metric.name == "long_gauge" && (metric.data.points[0] as! LongPointData).value == 10
}))
XCTAssertTrue(metrics.contains(where: { metric in
metric.name == "histogram" && (metric.getHistogramData()[0].min == 2.0 && metric.getHistogramData()[0].max == 2.0)
}))
XCTAssertTrue(metrics.contains(where: { metric in
metric.name == "upDown" && (metric.data.points[0] as! LongPointData).value == 100
Expand Down
Loading