diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/changes.xml | 55 | ||||
-rw-r--r-- | docs/unit-openapi.yaml | 92 |
2 files changed, 144 insertions, 3 deletions
diff --git a/docs/changes.xml b/docs/changes.xml index 511d37e1..d5cd5995 100644 --- a/docs/changes.xml +++ b/docs/changes.xml @@ -9,6 +9,57 @@ unit-python unit-python2.7 unit-python3.4 unit-python3.5 unit-python3.6 unit-python3.7 unit-python3.8 unit-python3.9 unit-python3.10 unit-python3.11 + unit-python3.12 unit-python3.13 + unit-go + unit-perl + unit-ruby + unit-jsc-common unit-jsc8 unit-jsc10 unit-jsc11 unit-jsc13 + unit-jsc14 unit-jsc15 unit-jsc16 unit-jsc17 unit-jsc18 + unit-jsc19 unit-jsc20 unit-jsc21 + unit-wasm" + ver="1.34.0" rev="1" + date="2024-12-19" time="18:00:00 +0000" + packager="Nginx Packaging <nginx-packaging@f5.com>"> + +<change> +<para> +NGINX Unit updated to 1.34.0. +</para> +</change> + +</changes> + + +<changes apply="unit" ver="1.34.0" rev="1" + date="2024-12-19" time="18:00:00 +0000" + packager="Nginx Packaging <nginx-packaging@f5.com>"> + +<change type="feature"> +<para> +initial OpenTelemetry (OTEL) support. (Disabled by default). +</para> +</change> + +<change type="feature"> +<para> +support for JSON formatted access logs. +</para> +</change> + +<change type="bugfix"> +<para> +tweak the Perl language module to avoid breaking scripts in some +circumstances. +</para> +</change> + +</changes> + + +<changes apply="unit-php + unit-python unit-python2.7 + unit-python3.4 unit-python3.5 unit-python3.6 unit-python3.7 + unit-python3.8 unit-python3.9 unit-python3.10 unit-python3.11 unit-python3.12 unit-go unit-perl @@ -18,7 +69,7 @@ unit-jsc19 unit-jsc20 unit-jsc21 unit-wasm" ver="1.33.0" rev="1" - date="" time="" + date="2024-09-17" time="18:00:00 +0000" packager="Nginx Packaging <nginx-packaging@f5.com>"> <change> @@ -31,7 +82,7 @@ NGINX Unit updated to 1.33.0. <changes apply="unit" ver="1.33.0" rev="1" - date="" time="" + date="2024-09-17" time="18:00:00 +0000" packager="Nginx Packaging <nginx-packaging@f5.com>"> <change type="feature"> diff --git a/docs/unit-openapi.yaml b/docs/unit-openapi.yaml index 37fca500..419b8da2 100644 --- a/docs/unit-openapi.yaml +++ b/docs/unit-openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - title: "NGINX Unit 1.32.1" + title: "NGINX Unit 1.34.0" description: "NGINX Unit is a lightweight and versatile application runtime that provides the essential components for your web application as a single open-source server: running application code, serving static assets, @@ -3090,6 +3090,68 @@ paths: "404": $ref: "#/components/responses/responseNotFound" + /config/settings/telemetry: + summary: "Endpoint for the `telemetry` object in `settings`" + get: + operationId: getSettingsTelemetry + summary: "Retrieve the `telemetry` object from settings" + description: "Retrieves the `telemetry` object that represents Unit's + [Telemetry settings](https://unit.nginx.org/configuration/#settings)." + tags: + - settings + - config + responses: + "200": + description: "Ok; the `telemetry` object exists in the configuration." + content: + application/json: + schema: + $ref: "#/components/schemas/configSettingsTelemetry" + "404": + $ref: "#/components/responses/responseNotFound" + + put: + operationId: putSettingsTelemetry + summary: "Create or update the `telemetry` object in settings" + description: "Creates or updates the `telemetry` object that represents Unit's + [Telemetry settings](https://unit.nginx.org/configuration/#settings)." + tags: + - settings + - config + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/configSettingsTelemetry" + responses: + "200": + $ref: "#/components/responses/responseOkUpdated" + + "400": + $ref: "#/components/responses/responseBadRequest" + + "404": + $ref: "#/components/responses/responseNotFound" + + "500": + $ref: "#/components/responses/responseInternalError" + + delete: + operationId: deleteSettingsTelemetry + summary: "Delete the telemetry object" + description: "Deletes the `telemetry` object from the configuration." + tags: + - settings + - config + + responses: + "200": + $ref: "#/components/responses/responseOkDeleted" + + "404": + $ref: "#/components/responses/responseNotFound" + /config/settings/http: summary: "Endpoint for the `http` object in `settings`" @@ -6545,10 +6607,38 @@ components: Unit settings." properties: + telemetry: + description: "Represents global telemetry settings in Unit." + $ref: "#/components/schemas/configSettingsTelemetry" + http: description: "Represents global HTTP settings in Unit." $ref: "#/components/schemas/configSettingsHttp" + # /config/settings/telemetry + configSettingsTelemetry: + type: object + description: "An object whose options represent global telemetry settings in Unit." + required: ["endpoint"] + properties: + batch_size: + type: integer + description: "Number of spans to cache before sending to telemetry collector." + default: 128 + + endpoint: + type: string + description: "A valid endpoint to which Unit can send OpenTelemetry spans." + + protocol: + type: string + description: "Protocol to use when communicating with the aforementioned endpoint." + + sampling_ratio: + type: number + default: 1 + description: "A number in between 0 and 1 that describes the percent of requests traced" + # /config/settings/http configSettingsHttp: type: object |