commit 26b031c

Merge: fb231b7 152509b Author: Martin <[email protected]> Date: Tue May 10 16:54:13 2022 +0200 Merge pull request #3759 from owncloud/graph-explorer-config-desc add description tags to graph-explorer config
owncloud · May 10, 2022 · 945a8ed · 945a8ed
1 parent 2060028
commit 945a8ed
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 30 deletions.
diff --git a/extensions/_includes/adoc/graph-explorer_configvars.adoc b/extensions/_includes/adoc/graph-explorer_configvars.adoc
@@ -11,49 +11,49 @@
 `GRAPH_EXPLORER_TRACING_ENABLED`
 | bool
 | false
-| 
+| Enable tracing.
 
 |`OCIS_TRACING_TYPE` +
 `GRAPH_EXPLORER_TRACING_TYPE`
 | string
 | 
-| 
+| The sampler type: remote, const, probabilistic, ratelimiting (default remote). See also https://www.jaegertracing.io/docs/latest/sampling/.
 
 |`OCIS_TRACING_ENDPOINT` +
 `GRAPH_EXPLORER_TRACING_ENDPOINT`
 | string
 | 
-| 
+| The endpoint of the tracing service.
 
 |`OCIS_TRACING_COLLECTOR` +
 `GRAPH_EXPLORER_TRACING_COLLECTOR`
 | string
 | 
-| 
+| The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. If specified, the tracing endpoint is ignored.
 
 |`OCIS_LOG_LEVEL` +
 `GRAPH_EXPLORER_LOG_LEVEL`
 | string
 | 
-| 
+| The log level.
 
 |`OCIS_LOG_PRETTY` +
 `GRAPH_EXPLORER_LOG_PRETTY`
 | bool
 | false
-| 
+| Enable pretty logs.
 
 |`OCIS_LOG_COLOR` +
 `GRAPH_EXPLORER_LOG_COLOR`
 | bool
 | false
-| 
+| Enable colored logs.
 
 |`OCIS_LOG_FILE` +
 `GRAPH_EXPLORER_LOG_FILE`
 | string
 | 
-| 
+| The path to the log file when logging to file.
 
 |`GRAPH_EXPLORER_DEBUG_ADDR`
 | string
@@ -78,12 +78,12 @@
 |`GRAPH_EXPLORER_HTTP_ADDR`
 | string
 | 127.0.0.1:9135
-| 
+| The HTTP service address.
 
 |`GRAPH_EXPLORER_HTTP_ROOT`
 | string
 | /graph-explorer
-| 
+| The HTTP service root path.
 
 |`GRAPH_EXPLORER_CLIENT_ID`
 | string

diff --git a/extensions/_includes/graph-explorer_configvars.md b/extensions/_includes/graph-explorer_configvars.md
@@ -2,20 +2,20 @@
 
 | Name | Type | Default Value | Description |
 |------|------|---------------|-------------|
-| OCIS_TRACING_ENABLED<br/>GRAPH_EXPLORER_TRACING_ENABLED | bool | false | |
-| OCIS_TRACING_TYPE<br/>GRAPH_EXPLORER_TRACING_TYPE | string |  | |
-| OCIS_TRACING_ENDPOINT<br/>GRAPH_EXPLORER_TRACING_ENDPOINT | string |  | |
-| OCIS_TRACING_COLLECTOR<br/>GRAPH_EXPLORER_TRACING_COLLECTOR | string |  | |
-| OCIS_LOG_LEVEL<br/>GRAPH_EXPLORER_LOG_LEVEL | string |  | |
-| OCIS_LOG_PRETTY<br/>GRAPH_EXPLORER_LOG_PRETTY | bool | false | |
-| OCIS_LOG_COLOR<br/>GRAPH_EXPLORER_LOG_COLOR | bool | false | |
-| OCIS_LOG_FILE<br/>GRAPH_EXPLORER_LOG_FILE | string |  | |
+| OCIS_TRACING_ENABLED<br/>GRAPH_EXPLORER_TRACING_ENABLED | bool | false | Enable tracing.|
+| OCIS_TRACING_TYPE<br/>GRAPH_EXPLORER_TRACING_TYPE | string |  | The sampler type: remote, const, probabilistic, ratelimiting (default remote). See also https://www.jaegertracing.io/docs/latest/sampling/.|
+| OCIS_TRACING_ENDPOINT<br/>GRAPH_EXPLORER_TRACING_ENDPOINT | string |  | The endpoint of the tracing service.|
+| OCIS_TRACING_COLLECTOR<br/>GRAPH_EXPLORER_TRACING_COLLECTOR | string |  | The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. If specified, the tracing endpoint is ignored.|
+| OCIS_LOG_LEVEL<br/>GRAPH_EXPLORER_LOG_LEVEL | string |  | The log level.|
+| OCIS_LOG_PRETTY<br/>GRAPH_EXPLORER_LOG_PRETTY | bool | false | Enable pretty logs.|
+| OCIS_LOG_COLOR<br/>GRAPH_EXPLORER_LOG_COLOR | bool | false | Enable colored logs.|
+| OCIS_LOG_FILE<br/>GRAPH_EXPLORER_LOG_FILE | string |  | The path to the log file when logging to file.|
 | GRAPH_EXPLORER_DEBUG_ADDR | string | 127.0.0.1:9136 | |
 | GRAPH_EXPLORER_DEBUG_TOKEN | string |  | |
 | GRAPH_EXPLORER_DEBUG_PPROF | bool | false | |
 | GRAPH_EXPLORER_DEBUG_ZPAGES | bool | false | |
-| GRAPH_EXPLORER_HTTP_ADDR | string | 127.0.0.1:9135 | |
-| GRAPH_EXPLORER_HTTP_ROOT | string | /graph-explorer | |
+| GRAPH_EXPLORER_HTTP_ADDR | string | 127.0.0.1:9135 | The HTTP service address.|
+| GRAPH_EXPLORER_HTTP_ROOT | string | /graph-explorer | The HTTP service root path.|
 | GRAPH_EXPLORER_CLIENT_ID | string | ocis-explorer.js | |
 | OCIS_URL<br/>OCIS_OIDC_ISSUER<br/>GRAPH_EXPLORER_ISSUER | string | https://localhost:9200 | |
 | OCIS_URL<br/>GRAPH_EXPLORER_GRAPH_URL_BASE | string | https://localhost:9200 | |

diff --git a/grpc_apis/ocis/messages/accounts/v0/grpc.md b/grpc_apis/ocis/messages/accounts/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.accounts.v0"
 url: /grpc_apis/ocis_messages_accounts_v0
-date: 2022-05-10T13:39:16Z
+date: 2022-05-10T14:55:30Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/messages/search/v0/grpc.md b/grpc_apis/ocis/messages/search/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.search.v0"
 url: /grpc_apis/ocis_messages_search_v0
-date: 2022-05-10T13:39:16Z
+date: 2022-05-10T14:55:30Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/messages/settings/v0/grpc.md b/grpc_apis/ocis/messages/settings/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.settings.v0"
 url: /grpc_apis/ocis_messages_settings_v0
-date: 2022-05-10T13:39:16Z
+date: 2022-05-10T14:55:30Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/messages/store/v0/grpc.md b/grpc_apis/ocis/messages/store/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.store.v0"
 url: /grpc_apis/ocis_messages_store_v0
-date: 2022-05-10T13:39:16Z
+date: 2022-05-10T14:55:30Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/messages/thumbnails/v0/grpc.md b/grpc_apis/ocis/messages/thumbnails/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.thumbnails.v0"
 url: /grpc_apis/ocis_messages_thumbnails_v0
-date: 2022-05-10T13:39:16Z
+date: 2022-05-10T14:55:30Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/accounts/v0/grpc.md b/grpc_apis/ocis/services/accounts/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.accounts.v0"
 url: /grpc_apis/ocis_services_accounts_v0
-date: 2022-05-10T13:39:16Z
+date: 2022-05-10T14:55:30Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/search/v0/grpc.md b/grpc_apis/ocis/services/search/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.search.v0"
 url: /grpc_apis/ocis_services_search_v0
-date: 2022-05-10T13:39:16Z
+date: 2022-05-10T14:55:30Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/settings/v0/grpc.md b/grpc_apis/ocis/services/settings/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.settings.v0"
 url: /grpc_apis/ocis_services_settings_v0
-date: 2022-05-10T13:39:16Z
+date: 2022-05-10T14:55:30Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/store/v0/grpc.md b/grpc_apis/ocis/services/store/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.store.v0"
 url: /grpc_apis/ocis_services_store_v0
-date: 2022-05-10T13:39:16Z
+date: 2022-05-10T14:55:30Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/thumbnails/v0/grpc.md b/grpc_apis/ocis/services/thumbnails/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.thumbnails.v0"
 url: /grpc_apis/ocis_services_thumbnails_v0
-date: 2022-05-10T13:39:16Z
+date: 2022-05-10T14:55:30Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---