Graph Explorer Extension Configuration

Introduction

The Infinite Scale Graph Explorer extension provides …​

Extensions are under development because of the beta badge 1 stage of Infinite Scale. Their service, environment variables and configuration may change. Forgive us if there are mistakes or information is missing. Feel free to report issues and we’ll take care of them as soon as possible on github. You want to fix them yourself? We’d appreciate that even more.

Configuration

Environment Variables

The graph-explorer extension is configured via the following environment variables:

Environment variables for the graph-explorer extension
Name Type Default Value Description

OCIS_TRACING_ENABLED
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

127.0.0.1:9136

Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.

GRAPH_EXPLORER_DEBUG_TOKEN

string

Token to secure the metrics endpoint

GRAPH_EXPLORER_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling

GRAPH_EXPLORER_DEBUG_ZPAGES

bool

false

Enables zpages, which can be used for collecting and viewing traces in-me

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
OCIS_OIDC_ISSUER
GRAPH_EXPLORER_ISSUER

string

https://localhost:9200

OCIS_URL
GRAPH_EXPLORER_GRAPH_URL_BASE

string

https://localhost:9200

GRAPH_EXPLORER_GRAPH_URL_PATH

string

/graph

Since Version: + added, - deprecated

YAML Example

# Autogenerated
# Filename: graph-explorer-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9136
  token: ""
  pprof: false
  zpages: false
http:
  addr: 127.0.0.1:9135
  root: /graph-explorer
graph_explorer:
  client_id: ocis-explorer.js
  issuer: https://localhost:9200
  graph_url_base: https://localhost:9200
  graph_url_path: /graph