From dee4560d1b88b29618a9a4ad3d6afc75b980e03a Mon Sep 17 00:00:00 2001 From: svrnm Date: Mon, 8 Nov 2021 20:16:31 +0100 Subject: [PATCH 1/5] Add Service to glossary.md --- specification/glossary.md | 55 ++++++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 24 deletions(-) diff --git a/specification/glossary.md b/specification/glossary.md index afe71ec5be4..e83cec1c99f 100644 --- a/specification/glossary.md +++ b/specification/glossary.md @@ -9,32 +9,33 @@ Some other fundamental terms are documented in the [overview document](overview. - [User Roles](#user-roles) - * [Application Owner](#application-owner) - * [Library Author](#library-author) - * [Instrumentation Author](#instrumentation-author) - * [Plugin Author](#plugin-author) + - [Application Owner](#application-owner) + - [Library Author](#library-author) + - [Instrumentation Author](#instrumentation-author) + - [Plugin Author](#plugin-author) - [Common](#common) - * [Signals](#signals) - * [Packages](#packages) - * [ABI Compatibility](#abi-compatibility) - * [In-band and Out-of-band Data](#in-band-and-out-of-band-data) - * [Manual Instrumentation](#manual-instrumentation) - * [Automatic Instrumentation](#automatic-instrumentation) - * [Telemetry SDK](#telemetry-sdk) - * [Constructors](#constructors) - * [SDK Plugins](#sdk-plugins) - * [Exporter Library](#exporter-library) - * [Instrumented Library](#instrumented-library) - * [Instrumentation Library](#instrumentation-library) - * [Tracer Name / Meter Name](#tracer-name--meter-name) + - [Signals](#signals) + - [Packages](#packages) + - [ABI Compatibility](#abi-compatibility) + - [In-band and Out-of-band Data](#in-band-and-out-of-band-data) + - [Manual Instrumentation](#manual-instrumentation) + - [Automatic Instrumentation](#automatic-instrumentation) + - [Telemetry SDK](#telemetry-sdk) + - [Constructors](#constructors) + - [SDK Plugins](#sdk-plugins) + - [Exporter Library](#exporter-library) + - [Instrumented Library](#instrumented-library) + - [Instrumentation Library](#instrumentation-library) + - [Tracer Name / Meter Name](#tracer-name--meter-name) + - [Service](#service) - [Logs](#logs) - * [Log Record](#log-record) - * [Log](#log) - * [Embedded Log](#embedded-log) - * [Standalone Log](#standalone-log) - * [Log Attributes](#log-attributes) - * [Structured Logs](#structured-logs) - * [Flat File Logs](#flat-file-logs) + - [Log Record](#log-record) + - [Log](#log) + - [Embedded Log](#embedded-log) + - [Standalone Log](#standalone-log) + - [Log Attributes](#log-attributes) + - [Structured Logs](#structured-logs) + - [Flat File Logs](#flat-file-logs) @@ -153,6 +154,12 @@ This refers to the `name` and (optional) `version` arguments specified when creating a new `Tracer` or `Meter` (see [Obtaining a Tracer](trace/api.md#tracerprovider)/[Obtaining a Meter](metrics/api.md#meterprovider)). The name/version pair identifies the [Instrumentation Library](#instrumentation-library). +### Service + +`Services` expose unique functions to another and are identified by a namespace and a name. There are one or more instances of the same service called `Service Instance`. Often such a service instance is enclosed within an operating system process. There could be multiple versions of the same service. + +See [Resource Semantic Conventions - Service](resource/semantic_conventions/README.md#service) for more details and naming requirements. + ## Logs ### Log Record From c87254c82e10393f5749c03db789b5e0463ee537 Mon Sep 17 00:00:00 2001 From: svrnm Date: Mon, 8 Nov 2021 20:24:14 +0100 Subject: [PATCH 2/5] revert changes from glossary toc --- specification/glossary.md | 50 +++++++++++++++++++-------------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/specification/glossary.md b/specification/glossary.md index e83cec1c99f..500d0fc8867 100644 --- a/specification/glossary.md +++ b/specification/glossary.md @@ -9,33 +9,33 @@ Some other fundamental terms are documented in the [overview document](overview. - [User Roles](#user-roles) - - [Application Owner](#application-owner) - - [Library Author](#library-author) - - [Instrumentation Author](#instrumentation-author) - - [Plugin Author](#plugin-author) + * [Application Owner](#application-owner) + * [Library Author](#library-author) + * [Instrumentation Author](#instrumentation-author) + * [Plugin Author](#plugin-author) - [Common](#common) - - [Signals](#signals) - - [Packages](#packages) - - [ABI Compatibility](#abi-compatibility) - - [In-band and Out-of-band Data](#in-band-and-out-of-band-data) - - [Manual Instrumentation](#manual-instrumentation) - - [Automatic Instrumentation](#automatic-instrumentation) - - [Telemetry SDK](#telemetry-sdk) - - [Constructors](#constructors) - - [SDK Plugins](#sdk-plugins) - - [Exporter Library](#exporter-library) - - [Instrumented Library](#instrumented-library) - - [Instrumentation Library](#instrumentation-library) - - [Tracer Name / Meter Name](#tracer-name--meter-name) - - [Service](#service) + * [Signals](#signals) + * [Packages](#packages) + * [ABI Compatibility](#abi-compatibility) + * [In-band and Out-of-band Data](#in-band-and-out-of-band-data) + * [Manual Instrumentation](#manual-instrumentation) + * [Automatic Instrumentation](#automatic-instrumentation) + * [Telemetry SDK](#telemetry-sdk) + * [Constructors](#constructors) + * [SDK Plugins](#sdk-plugins) + * [Exporter Library](#exporter-library) + * [Instrumented Library](#instrumented-library) + * [Instrumentation Library](#instrumentation-library) + * [Tracer Name / Meter Name](#tracer-name--meter-name) + * [Service](#service) - [Logs](#logs) - - [Log Record](#log-record) - - [Log](#log) - - [Embedded Log](#embedded-log) - - [Standalone Log](#standalone-log) - - [Log Attributes](#log-attributes) - - [Structured Logs](#structured-logs) - - [Flat File Logs](#flat-file-logs) + * [Log Record](#log-record) + * [Log](#log) + * [Embedded Log](#embedded-log) + * [Standalone Log](#standalone-log) + * [Log Attributes](#log-attributes) + * [Structured Logs](#structured-logs) + * [Flat File Logs](#flat-file-logs) From 7cdd5bf885ea3668c39fdaf29bd701d40398a2c4 Mon Sep 17 00:00:00 2001 From: svrnm Date: Fri, 12 Nov 2021 14:25:01 +0100 Subject: [PATCH 3/5] update service and service instance definitions --- specification/glossary.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/specification/glossary.md b/specification/glossary.md index 500d0fc8867..234047159e1 100644 --- a/specification/glossary.md +++ b/specification/glossary.md @@ -156,7 +156,9 @@ The name/version pair identifies the [Instrumentation Library](#instrumentation- ### Service -`Services` expose unique functions to another and are identified by a namespace and a name. There are one or more instances of the same service called `Service Instance`. Often such a service instance is enclosed within an operating system process. There could be multiple versions of the same service. +A `service` is a component of a larger distributed `application`. A service logically represents a repeatable business activity with a specified outcome. A service exchanges information with other services via some form of inter-process communication mechanism, such as network or shared storage. + +A `service instance` is a physical manifestation of a service, usually running in its own operating system process. Multiple service instances are typically deployed at the same time for high availability and scalability. See [Resource Semantic Conventions - Service](resource/semantic_conventions/README.md#service) for more details and naming requirements. From 0902c2614727417f7248146fed5113a9a64dbfe2 Mon Sep 17 00:00:00 2001 From: svrnm Date: Mon, 22 Nov 2021 16:36:30 +0100 Subject: [PATCH 4/5] link from service in semconv to glossary --- specification/resource/semantic_conventions/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index ab5fe29d455..54176a96834 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -60,7 +60,7 @@ as specified in the [Resource SDK specification](../sdk.md#sdk-provided-resource **type:** `service` -**Description:** A service instance. +**Description:** A [service](../../glossary.md#service) instance. | Attribute | Type | Description | Examples | Required | From 8cbfe52e4126611d509bd20d60b12bbcb4e2f021 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Mon, 3 Jan 2022 13:52:16 +0100 Subject: [PATCH 5/5] Update specification/glossary.md Co-authored-by: Nikita Salnikov-Tarnovski --- specification/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/glossary.md b/specification/glossary.md index 234047159e1..79fe90acd31 100644 --- a/specification/glossary.md +++ b/specification/glossary.md @@ -158,7 +158,7 @@ The name/version pair identifies the [Instrumentation Library](#instrumentation- A `service` is a component of a larger distributed `application`. A service logically represents a repeatable business activity with a specified outcome. A service exchanges information with other services via some form of inter-process communication mechanism, such as network or shared storage. -A `service instance` is a physical manifestation of a service, usually running in its own operating system process. Multiple service instances are typically deployed at the same time for high availability and scalability. +A `service instance` is a physical manifestation of a service, usually running in its own operating system process. Multiple service instances may be deployed at the same time for high availability and scalability. See [Resource Semantic Conventions - Service](resource/semantic_conventions/README.md#service) for more details and naming requirements.