Skip to content
This repository has been archived by the owner. It is now read-only.
Browse files
docs: add env vars explain
  • Loading branch information
hanhxiao committed Sep 26, 2019
1 parent 086a73c commit 9ad7448f135cb42149b905b91b42c1a22c31a65c
Showing with 42 additions and 1 deletion.
  1. +40 −0 docs/chapter/
  2. +1 −0 docs/index.rst
  3. +1 −1 tests/
@@ -0,0 +1,40 @@
# Environment Variables

There are couple of environment variables that GNES respect during runtime.


Set to any non-empty string to turn on service-level time profiling for GNES.

Default is disabled.


Set to any non-empty string to turn on service-level memory profiling for GNES. Warning, memory profiling could hurt the efficiency significantly.

Default is disabled.


Set to `0` to turn off the warning like `this object is not named ("name" is not found under "gnes_config" in YAML config), i will call it "BaseRouter-51ce94cc". naming the object is important as it provides an unique identifier when serializing/deserializing this object.`

Set to `1` to enable it.

Default is enabled.


Git version of GNES. This is used when `--check_version` is turned on. For GNES official docker image, `GNES_VCS_VERSION` is automatically set to the git version during the building procedure.

Default is the git head version when building docker image. Otherwise it is not set.


Control port of the microservice. Useful when doing health check via `gnes healthcheck`.

Default is not set. A random port will be used.


(*depreciated*) Paths of the third party components. See examples in GNES hub for latest usage.

@@ -68,6 +68,7 @@ Highlights


.. toctree::
:maxdepth: 2
@@ -47,7 +47,7 @@ def test_health_check(self):
self.assertEqual(cm.exception.code, 1)

def test_hc_os_env(self):
os.environ.setdefault('GNES_CONTROL_PORT', str(56789))
os.environ['GNES_CONTROL_PORT'] = str(56789)
a = set_router_parser().parse_args([
'--yaml_path', 'BaseRouter',

0 comments on commit 9ad7448

Please sign in to comment.