Skip to content

Commit 4c11dea

Browse files
chalinchalin
authored
Add OpAMP spec (open-telemetry#2926)
1 parent 5b82523 commit 4c11dea

File tree

7 files changed

+142
-2
lines changed

7 files changed

+142
-2
lines changed

‎.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,6 @@
1414
[submodule "content-modules/semantic-conventions"]
1515
path = content-modules/semantic-conventions
1616
url = https://github.com/open-telemetry/semantic-conventions
17+
[submodule "content-modules/opamp-spec"]
18+
path = content-modules/opamp-spec
19+
url = https://github.com/open-telemetry/opamp-spec

‎.htmltest.yml

+4
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,7 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
3939
- ^https://open-telemetry\.github\.io/opentelemetry-python/benchmarks/
4040
# TODO: remove after merge of https://github.com/open-telemetry/opentelemetry.io/pull/2594
4141
- ^https://elastic.co/blog/ecs-elastic-common-schema-otel-opentelemetry-announcement
42+
# TODO: remove after OpAMP spec is fixed: https://github.com/open-telemetry/opamp-spec/issues/148
43+
- ^https://example.com:4318/v1/metrics
44+
- ^https://pdf.sciencedirectassets.com/280203/1-s2.0-S1877050919X0006X
45+
- ^https://research.fb.com/wp-content/uploads/2016/11/holistic-configuration-management-at-facebook.pdf

‎content-modules/opamp-spec

Submodule opamp-spec added at e19c666

‎hugo.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,8 @@ module:
181181
target: content
182182
- source: tmp/otel/specification
183183
target: content/docs/specs/otel
184+
- source: tmp/opamp
185+
target: content/docs/specs/opamp
184186
- source: tmp/otlp/docs/specification.md
185187
target: content/docs/specs/otlp/_index.md
186188
- source: tmp/otlp/docs/img

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

+22-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
my $gD = 0;
1414
my $otelSpecRepoUrl = 'https://github.com/open-telemetry/opentelemetry-specification';
1515
my $otlpSpecRepoUrl = 'https://github.com/open-telemetry/opentelemetry-proto';
16+
my $opAmpSpecRepoUrl = 'https://github.com/open-telemetry/opamp-spec';
1617
my $semConvRef = "$otelSpecRepoUrl/blob/main/semantic_conventions/README.md";
1718
my $specBasePath = '/docs/specs';
1819
my $path_base_for_github_subdir = "content/en$specBasePath";
@@ -23,6 +24,17 @@
2324
my $otelSpecVers = $versions{'spec:'};
2425
my $otlpSpecVers = $versions{'otlp:'};
2526
my $unused;
27+
# TODO: remove once OpAMP spec has been updated
28+
my $opampFrontMatter = << "EOS";
29+
title: Open Agent Management Protocol
30+
linkTitle: OpAMP
31+
body_class: otel-docs-spec
32+
github_repo: &repo $opAmpSpecRepoUrl
33+
github_project_repo: *repo
34+
path_base_for_github_subdir:
35+
from: content/en/docs/specs/opamp/index.md
36+
to: specification.md
37+
EOS
2638

2739
sub printTitleAndFrontMatter() {
2840
print "---\n";
@@ -31,10 +43,13 @@ ()
3143
$frontMatterFromFile =~ s/(linkTitle:) .*/$1 OTel $otelSpecVers/;
3244
} elsif ($title eq 'OpenTelemetry Protocol Specification') {
3345
$frontMatterFromFile =~ s/(title|linkTitle): .*/$& $otlpSpecVers/g;
46+
} elsif ($title eq 'OpAMP: Open Agent Management Protocol') {
47+
$frontMatterFromFile = $opampFrontMatter unless $frontMatterFromFile;
3448
}
3549
my $titleMaybeQuoted = ($title =~ ':') ? "\"$title\"" : $title;
3650
print "title: $titleMaybeQuoted\n" if $frontMatterFromFile !~ /title: /;
3751
($unused, $linkTitle) = $title =~ /^OpenTelemetry (Protocol )?(.*)/;
52+
# TODO: add to front matter of OTel spec file and drop next line:
3853
$linkTitle = 'Design Goals' if $title eq 'Design Goals for OpenTelemetry Wire Protocol';
3954
print "linkTitle: $linkTitle\n" if $linkTitle and $frontMatterFromFile !~ /linkTitle: /;
4055
print "$frontMatterFromFile" if $frontMatterFromFile;
@@ -87,7 +102,7 @@ ()
87102

88103
if (
89104
/\((https:\/\/github.com\/open-telemetry\/opentelemetry-specification\/\w+\/\w+\/specification([^\)]*))\)/ &&
90-
$ARGV !~ /semantic_conventions|otlp\/docs/
105+
$ARGV !~ /tmp\/(opamp|otlp\/docs)|semantic_conventions/
91106
) {
92107
printf STDOUT "WARNING: link to spec page encoded as an external URL, but should be a local path, fix this upstream;\n File: $ARGV \n Link: $1\n";
93108
}
@@ -127,5 +142,11 @@ ()
127142
# Make website-local page references local:
128143
s|https://opentelemetry.io/|/|g;
129144

145+
## OpAMP
146+
147+
s|\]\((proto/opamp.proto)\)|]($opAmpSpecRepoUrl/blob/main/$1)|;
148+
# TODO: drop once OpAMP spec has been updated
149+
s|^#+|#$&| if $ARGV =~ /\/opamp/;
150+
130151
print;
131152
}

‎scripts/content-modules/cp-pages.sh

+18-1
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,21 @@ FILES=$(find $DEST -name "*.md")
8282

8383
$SCRIPT_DIR/adjust-pages.pl $FILES
8484

85-
echo "OTEL SEMCONV pages: copied and processed"
85+
echo "SEM CONV pages: copied and processed"
86+
87+
## OpAMP spec
88+
89+
SRC=content-modules/opamp-spec
90+
DEST=$DEST_BASE/opamp
91+
92+
rm -Rf $DEST
93+
mkdir -p $DEST
94+
# Note: in contrast to other projects, we're copying a single file here
95+
cp $SRC/specification.md $DEST/index.md
96+
97+
# To exclude a file use, e.g.: -not -path '*/specification/_index.md'
98+
FILES=$(find $DEST -name "*.md")
99+
100+
$SCRIPT_DIR/adjust-pages.pl $FILES
101+
102+
echo "OpAMP SPEC page: copied and processed"

‎static/refcache.json

+92
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@
5151
"StatusCode": 200,
5252
"LastSeen": "2023-02-18T13:25:07.086804-05:00"
5353
},
54+
"http://www.watersprings.org/pub/id/draft-moriarty-acme-client-01.html": {
55+
"StatusCode": 206,
56+
"LastSeen": "2023-06-28T13:37:47.265343-04:00"
57+
},
5458
"https://Prometheus.io/docs/Prometheus/latest/federation/": {
5559
"StatusCode": 206,
5660
"LastSeen": "2023-02-18T14:04:08.728502-05:00"
@@ -139,6 +143,10 @@
139143
"StatusCode": 200,
140144
"LastSeen": "2023-02-15T20:22:15.105647-05:00"
141145
},
146+
"https://aws.amazon.com/elasticloadbalancing/features/": {
147+
"StatusCode": 200,
148+
"LastSeen": "2023-06-28T13:37:52.400412-04:00"
149+
},
142150
"https://azure.microsoft.com/": {
143151
"StatusCode": 200,
144152
"LastSeen": "2023-02-15T20:21:03.223444-05:00"
@@ -299,6 +307,10 @@
299307
"StatusCode": 200,
300308
"LastSeen": "2023-03-06T12:32:31.245277-05:00"
301309
},
310+
"https://cloud.google.com/appengine/docs/flexible/go/using-websockets-and-session-affinity": {
311+
"StatusCode": 200,
312+
"LastSeen": "2023-06-28T13:37:57.972295-04:00"
313+
},
302314
"https://cloud.google.com/artifact-registry": {
303315
"StatusCode": 200,
304316
"LastSeen": "2023-02-15T20:40:21.583943-05:00"
@@ -319,6 +331,10 @@
319331
"StatusCode": 200,
320332
"LastSeen": "2023-06-27T17:17:56.736764-04:00"
321333
},
334+
"https://cloud.google.com/compute/docs/metadata/querying-metadata#waitforchange": {
335+
"StatusCode": 200,
336+
"LastSeen": "2023-06-28T13:36:57.457831-04:00"
337+
},
322338
"https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.events/report": {
323339
"StatusCode": 200,
324340
"LastSeen": "2023-02-15T20:39:17.120733-05:00"
@@ -483,18 +499,50 @@
483499
"StatusCode": 200,
484500
"LastSeen": "2023-05-15T13:58:32.732504-04:00"
485501
},
502+
"https://datatracker.ietf.org/doc/html/rfc6455": {
503+
"StatusCode": 200,
504+
"LastSeen": "2023-06-28T13:35:27.584947-04:00"
505+
},
506+
"https://datatracker.ietf.org/doc/html/rfc6455#section-5.5.1": {
507+
"StatusCode": 200,
508+
"LastSeen": "2023-06-28T13:36:08.991662-04:00"
509+
},
510+
"https://datatracker.ietf.org/doc/html/rfc6585#section-4": {
511+
"StatusCode": 200,
512+
"LastSeen": "2023-06-28T13:36:29.941341-04:00"
513+
},
514+
"https://datatracker.ietf.org/doc/html/rfc6750": {
515+
"StatusCode": 200,
516+
"LastSeen": "2023-06-28T13:36:14.376172-04:00"
517+
},
486518
"https://datatracker.ietf.org/doc/html/rfc7230#section-2.7.1": {
487519
"StatusCode": 200,
488520
"LastSeen": "2023-02-15T21:09:50.310882-05:00"
489521
},
522+
"https://datatracker.ietf.org/doc/html/rfc7231#page-63": {
523+
"StatusCode": 200,
524+
"LastSeen": "2023-06-28T13:36:24.749193-04:00"
525+
},
490526
"https://datatracker.ietf.org/doc/html/rfc7231#section-5.5.3": {
491527
"StatusCode": 200,
492528
"LastSeen": "2023-02-15T21:09:55.695289-05:00"
493529
},
530+
"https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.3": {
531+
"StatusCode": 200,
532+
"LastSeen": "2023-06-28T13:36:35.06993-04:00"
533+
},
534+
"https://datatracker.ietf.org/doc/html/rfc7235#section-3.1": {
535+
"StatusCode": 200,
536+
"LastSeen": "2023-06-28T13:36:19.575605-04:00"
537+
},
494538
"https://datatracker.ietf.org/doc/html/rfc7617": {
495539
"StatusCode": 200,
496540
"LastSeen": "2023-02-15T21:12:19.647161-05:00"
497541
},
542+
"https://datatracker.ietf.org/doc/html/rfc8555": {
543+
"StatusCode": 200,
544+
"LastSeen": "2023-06-28T13:37:41.457991-04:00"
545+
},
498546
"https://deno.land": {
499547
"StatusCode": 200,
500548
"LastSeen": "2023-02-15T21:14:20.22294-05:00"
@@ -559,10 +607,18 @@
559607
"StatusCode": 206,
560608
"LastSeen": "2023-02-15T21:09:38.6321-05:00"
561609
},
610+
"https://developers.google.com/protocol-buffers/docs/encoding#varints": {
611+
"StatusCode": 206,
612+
"LastSeen": "2023-06-28T13:35:37.944756-04:00"
613+
},
562614
"https://developers.google.com/protocol-buffers/docs/overview": {
563615
"StatusCode": 206,
564616
"LastSeen": "2023-02-15T21:09:33.425461-05:00"
565617
},
618+
"https://developers.google.com/protocol-buffers/docs/proto3": {
619+
"StatusCode": 206,
620+
"LastSeen": "2023-06-28T13:35:43.128896-04:00"
621+
},
566622
"https://developers.google.com/protocol-buffers/docs/proto3#json": {
567623
"StatusCode": 206,
568624
"LastSeen": "2023-02-15T21:09:43.885827-05:00"
@@ -899,6 +955,10 @@
899955
"StatusCode": 200,
900956
"LastSeen": "2023-02-15T21:06:35.608047-05:00"
901957
},
958+
"https://docs.microsoft.com/en-us/azure/application-gateway/application-gateway-websocket": {
959+
"StatusCode": 200,
960+
"LastSeen": "2023-06-28T13:38:08.22182-04:00"
961+
},
902962
"https://docs.microsoft.com/en-us/azure/azure-functions/manage-connections#static-clients": {
903963
"StatusCode": 200,
904964
"LastSeen": "2023-02-15T21:07:44.902091-05:00"
@@ -1171,6 +1231,10 @@
11711231
"StatusCode": 206,
11721232
"LastSeen": "2023-03-11T14:17:28.309561-05:00"
11731233
},
1234+
"https://docs.splunk.com/Documentation/Splunk/8.2.2/Updating/Aboutdeploymentserver": {
1235+
"StatusCode": 200,
1236+
"LastSeen": "2023-06-28T13:36:40.606057-04:00"
1237+
},
11741238
"https://docs.teletrace.io/": {
11751239
"StatusCode": 206,
11761240
"LastSeen": "2023-04-15T22:50:33.371377+03:00"
@@ -1183,6 +1247,10 @@
11831247
"StatusCode": 206,
11841248
"LastSeen": "2023-02-26T11:00:42.522142-08:00"
11851249
},
1250+
"https://docs.vmware.com/en/vRealize-Log-Insight/8.4/com.vmware.log-insight.agent.admin.doc/GUID-40C13E10-1554-4F1B-B832-69CEBF85E7A0.html": {
1251+
"StatusCode": 206,
1252+
"LastSeen": "2023-06-28T13:36:46.411249-04:00"
1253+
},
11861254
"https://docs.wavefront.com/opentelemetry_tracing.html": {
11871255
"StatusCode": 206,
11881256
"LastSeen": "2023-02-15T21:01:54.460528-05:00"
@@ -1391,6 +1459,10 @@
13911459
"StatusCode": 200,
13921460
"LastSeen": "2023-02-15T21:19:21.209086-05:00"
13931461
},
1462+
"https://eng.uber.com/flipr/": {
1463+
"StatusCode": 200,
1464+
"LastSeen": "2023-06-28T13:37:10.406772-04:00"
1465+
},
13941466
"https://equalitymi.org/": {
13951467
"StatusCode": 200,
13961468
"LastSeen": "2023-02-15T21:20:40.685445-05:00"
@@ -1539,6 +1611,10 @@
15391611
"StatusCode": 200,
15401612
"LastSeen": "2023-02-20T07:56:36.215942-05:00"
15411613
},
1614+
"https://github.com/GoogleCloudPlatform/guest-agent": {
1615+
"StatusCode": 200,
1616+
"LastSeen": "2023-06-28T13:36:51.820995-04:00"
1617+
},
15421618
"https://github.com/GoogleCloudPlatform/microservices-demo": {
15431619
"StatusCode": 200,
15441620
"LastSeen": "2023-02-20T08:03:02.888162-05:00"
@@ -2051,6 +2127,10 @@
20512127
"StatusCode": 200,
20522128
"LastSeen": "2023-03-04T15:56:33.769146+05:30"
20532129
},
2130+
"https://github.com/open-telemetry/opamp-spec/issues/new": {
2131+
"StatusCode": 200,
2132+
"LastSeen": "2023-06-28T13:35:22.37888-04:00"
2133+
},
20542134
"https://github.com/open-telemetry/opentelemetry-collector": {
20552135
"StatusCode": 200,
20562136
"LastSeen": "2023-02-20T07:45:04.728771-05:00"
@@ -3299,6 +3379,10 @@
32993379
"StatusCode": 206,
33003380
"LastSeen": "2023-02-16T17:12:53.588932-05:00"
33013381
},
3382+
"https://kofo.dev/how-to-mtls-in-golang": {
3383+
"StatusCode": 200,
3384+
"LastSeen": "2023-06-28T13:37:30.706262-04:00"
3385+
},
33023386
"https://kubernetes.github.io/ingress-nginx/examples/grpc/": {
33033387
"StatusCode": 206,
33043388
"LastSeen": "2023-02-16T17:12:37.551902-05:00"
@@ -3951,6 +4035,10 @@
39514035
"StatusCode": 200,
39524036
"LastSeen": "2023-02-20T08:26:15.285143-05:00"
39534037
},
4038+
"https://pwn.recipes/posts/roll-your-own-e2ee-protocol/": {
4039+
"StatusCode": 200,
4040+
"LastSeen": "2023-06-28T13:37:36.342515-04:00"
4041+
},
39544042
"https://pypi.org/project/opentelemetry-api/": {
39554043
"StatusCode": 206,
39564044
"LastSeen": "2023-05-05T14:18:57.011667-07:00"
@@ -4479,6 +4567,10 @@
44794567
"StatusCode": 206,
44804568
"LastSeen": "2023-02-20T08:26:04.497414-05:00"
44814569
},
4570+
"https://www.gnupg.org/gph/en/manual/x135.html#AEN160": {
4571+
"StatusCode": 206,
4572+
"LastSeen": "2023-06-28T13:36:03.871847-04:00"
4573+
},
44824574
"https://www.gsse.biz/pdfs/papers/DASIA2018-abstract.pdf": {
44834575
"StatusCode": 206,
44844576
"LastSeen": "2023-03-30T19:59:23.7534-04:00"

0 commit comments

Comments
 (0)