From a3a9485015dc5f75c31535032cfb379af0d2732f Mon Sep 17 00:00:00 2001 From: Brett Logan Date: Thu, 14 Nov 2019 14:08:47 -0500 Subject: [PATCH] [FAB-17068] Add doc for /version endpoint Signed-off-by: Brett Logan Change-Id: I81e26dde3169096c2951ae69953733f6cb545b98 --- docs/source/operations_service.rst | 8 ++++++++ docs/source/whatsnew.rst | 3 +++ 2 files changed, 11 insertions(+) diff --git a/docs/source/operations_service.rst b/docs/source/operations_service.rst index 6bf21917e60..e792158719b 100644 --- a/docs/source/operations_service.rst +++ b/docs/source/operations_service.rst @@ -10,6 +10,7 @@ The API exposes the following capabilities: - Log level management - Health checks - Prometheus target for operational metrics (when configured) +- Version information Configuring the Operations Service ---------------------------------- @@ -304,5 +305,12 @@ metrics. For a look at the different metrics that are generated, check out :doc:`metrics_reference`. +Version +------- + +The orderer and peer both expose a ``/version`` endpoint. This endpoint +serves a JSON document containing the orderer or peer version and the commit +SHA on which the release was cut. + .. Licensed under Creative Commons Attribution 4.0 International License https://creativecommons.org/licenses/by/4.0/ diff --git a/docs/source/whatsnew.rst b/docs/source/whatsnew.rst index 9c96e851b1b..197b16feab5 100644 --- a/docs/source/whatsnew.rst +++ b/docs/source/whatsnew.rst @@ -75,6 +75,9 @@ is the recommended release for production operations. * The ``/metrics`` endpoint allows operators to utilize Prometheus to pull operational metrics from peer and orderer nodes. Metrics can also be pushed to StatsD. + * As of v1.4.4, the ``/version`` endpoint allows operators to query the release version + of the peer and orderer and the commit SHA from which the release was cut. + Improved programming model for developing applications ------------------------------------------------------