Skip to content

Commit 27cf07b

Browse files
chalinchalin
committed
Refcache + spec patches
1 parent bf38940 commit 27cf07b

File tree

3 files changed

+72
-11
lines changed

3 files changed

+72
-11
lines changed

‎content/en/blog/2024/otel-generative-ai/index.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The [Semantic Conventions for Generative AI](/docs/specs/semconv/gen-ai/) focus
4848
on capturing insights into AI model behavior through three primary signals:
4949
[Traces](/docs/concepts/signals/traces/),
5050
[Metrics](/docs/concepts/signals/metrics/), and
51-
[Events](/docs/specs/otel/logs/event-api/).
51+
[Events](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.40.0/specification/logs/event-api.md).
5252

5353
Together, these signals provide a comprehensive monitoring framework, enabling
5454
better cost management, performance tuning, and request tracing.
@@ -74,13 +74,19 @@ model responses, providing a granular view of model interactions. These insights
7474
are invaluable for debugging and optimizing AI applications where unexpected
7575
behaviors may arise.
7676

77-
{{% alert title="Note" color="info" %}} Note that we decided to use
78-
[events emitted](/docs/specs/otel/logs/api/#emit-an-event) with the
77+
{{% alert title="Note" color="info" %}}
78+
79+
Note that we decided to use [events emitted] with the
7980
[Logs API](/docs/specs/otel/logs/api/) specification in the Semantic Conventions
8081
for Generative AI. Events allows for us to define specific
8182
[semantic conventions](/docs/specs/semconv/general/events/) for the user prompts
8283
and model responses that we capture. This addition to the API is in development
83-
and considered unstable.{{% /alert %}}
84+
and considered unstable.
85+
86+
[events emitted]:
87+
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.40.0/specification/logs/api.md#emit-an-event
88+
89+
{{% /alert %}}
8490

8591
### Extending Observability with Vendor-Specific Attributes
8692

‎scripts/content-modules/adjust-pages.pl

+18-7
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ ()
6868

6969
sub printPatchInfoIf($$) {
7070
my ($patchID, $specVersTest) = @_;
71-
print STDOUT "INFO [$patchID]: $0: remove obsolete patch code now that OTel spec has been updated.\n"
71+
print STDOUT "INFO [$patchID]: $0: remove obsolete patch code now that spec(s) have been updated.\n"
7272
if $specVersTest && !$patchMsgCount{$patchID}++;
7373
}
7474

@@ -108,6 +108,13 @@ ($$)
108108
## Semconv
109109

110110
if ($ARGV =~ /\/semconv/) {
111+
my $otel_spec_event_deprecation = '(opentelemetry-specification/blob/main/specification/logs)/event-(api|sdk).md';
112+
if (/$otel_spec_event_deprecation/) {
113+
# Cf. https://github.com/open-telemetry/opentelemetry-specification/pull/4359
114+
s|$otel_spec_event_deprecation\b|$1/|g;
115+
printPatchInfoIf("2025-01-22-event-(api|sdk)", $semconvVers ne "1.29.0");
116+
}
117+
111118
s|(\]\()/docs/|$1$specBasePath/semconv/|g;
112119
s|(\]:\s*)/docs/|$1$specBasePath/semconv/|;
113120

@@ -124,12 +131,16 @@ ($$)
124131

125132
# SPECIFICATION custom processing
126133

127-
# TODO: drop the entire if statement patch code when OTel spec vers contains
128-
# https://github.com/open-telemetry/opentelemetry-specification/issues/4338,
129-
# which should be vers > 1.40.0.
130-
if ($ARGV =~ /otel\/specification\/logs/) {
131-
s|(/data-model.md/?)#event-name\b|$1#field-eventname|g;
132-
printPatchInfoIf("2024-12-13-event-name", $otelSpecVers ne "1.40.0");
134+
my $semconv_attr_naming_md = '(semantic-conventions/blob/main/docs/general)/naming.md(#\w+)?';
135+
if ($ARGV =~ /^tmp\/otel\/specification/ && /$semconv_attr_naming_md/) {
136+
s|$semconv_attr_naming_md\b|$1/attribute-naming.md|g;
137+
printPatchInfoIf("2025-01-22-attribute-naming.md", $otelSpecVers ne "1.41.0");
138+
}
139+
140+
my $semconv_attr_naming = '(/docs/specs/semconv/general)/naming/';
141+
if ($ARGV =~ /^tmp\/otel\/specification/ && /$semconv_attr_naming/) {
142+
s|$semconv_attr_naming|$1/attribute-naming/|g;
143+
printPatchInfoIf("2025-01-22-attribute-naming", $otelSpecVers ne "1.41.0");
133144
}
134145

135146
s|\(https://github.com/open-telemetry/opentelemetry-specification\)|($specBasePath/otel/)|;

‎static/refcache.json

+44
Original file line numberDiff line numberDiff line change
@@ -11207,6 +11207,14 @@
1120711207
"StatusCode": 206,
1120811208
"LastSeen": "2025-01-17T16:51:59.014871-05:00"
1120911209
},
11210+
"https://github.com/open-telemetry/opentelemetry-specification/blob/v1.40.0/specification/logs/api.md#emit-an-event": {
11211+
"StatusCode": 206,
11212+
"LastSeen": "2025-01-22T05:55:29.802398-05:00"
11213+
},
11214+
"https://github.com/open-telemetry/opentelemetry-specification/blob/v1.40.0/specification/logs/event-api.md": {
11215+
"StatusCode": 206,
11216+
"LastSeen": "2025-01-22T05:55:29.317655-05:00"
11217+
},
1121011218
"https://github.com/open-telemetry/opentelemetry-specification/compare/v1.24.0...v1.25.0": {
1121111219
"StatusCode": 200,
1121211220
"LastSeen": "2024-01-30T16:04:58.243312-05:00"
@@ -13195,6 +13203,42 @@
1319513203
"StatusCode": 200,
1319613204
"LastSeen": "2024-01-30T06:06:25.505322-05:00"
1319713205
},
13206+
"https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#counter-1": {
13207+
"StatusCode": 206,
13208+
"LastSeen": "2025-01-22T05:33:01.875313-05:00"
13209+
},
13210+
"https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#exemplars": {
13211+
"StatusCode": 206,
13212+
"LastSeen": "2025-01-22T05:33:02.735655-05:00"
13213+
},
13214+
"https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#gaugehistogram": {
13215+
"StatusCode": 206,
13216+
"LastSeen": "2025-01-22T05:32:59.977992-05:00"
13217+
},
13218+
"https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#info": {
13219+
"StatusCode": 206,
13220+
"LastSeen": "2025-01-22T05:32:54.414042-05:00"
13221+
},
13222+
"https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#metric": {
13223+
"StatusCode": 206,
13224+
"LastSeen": "2025-01-22T05:32:55.75186-05:00"
13225+
},
13226+
"https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#metricfamily": {
13227+
"StatusCode": 206,
13228+
"LastSeen": "2025-01-22T05:32:52.083975-05:00"
13229+
},
13230+
"https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#protobuf-format": {
13231+
"StatusCode": 206,
13232+
"LastSeen": "2025-01-22T05:32:55.492783-05:00"
13233+
},
13234+
"https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#stateset": {
13235+
"StatusCode": 206,
13236+
"LastSeen": "2025-01-22T05:32:57.022487-05:00"
13237+
},
13238+
"https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#supporting-target-metadata-in-both-push-based-and-pull-based-systems": {
13239+
"StatusCode": 206,
13240+
"LastSeen": "2025-01-22T05:33:04.063828-05:00"
13241+
},
1319813242
"https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#unit": {
1319913243
"StatusCode": 206,
1320013244
"LastSeen": "2025-01-16T13:35:25.270082-05:00"

0 commit comments

Comments
 (0)