Grafana Proxy

The technical documentation of the grafana-proxy microservice, which proxies request from Grafana to the backend services.

This microservice is still in development and is not considered stable for production use

How it works

The grafana-proxy microservice serves an HTTP REST endpoint located at /api/v1/{service}/{data}. The service parameter specifies the backend service to which the request should be proxied, like factoryinput or factoryinsight. The data parameter specifies the API endpoint to forward to the backend service. The body of the HTTP request is used as the payload for the proxied request.

Kubernetes resources

  • Deployment: united-manufacturing-hub-grafanaproxy
  • Service:
    • External LoadBalancer: united-manufacturing-hub-grafanaproxy-service at port 2096

Configuration

Environment variables

Environment variables
Variable nameDescriptionTypeAllowed valuesDefault
DEBUG_ENABLE_FGTRACEEnables the use of the fgtrace library. Not reccomended for productionstringtrue, falsefalse
FACTORYINPUT_BASE_URLURL of factoryinputstringAnyhttp://united-manufacturing-hub-factoryinput-service
FACTORYINPUT_KEYSpecifies the password for the admin user for factoryinputstringAnyRandom UUID
FACTORYINPUT_USERSpecifies the admin user for factoryinputstringAnyfactoryinput
FACTORYINSIGHT_BASE_URLURL of factoryinsightstringAnyhttp://united-manufacturing-hub-factoryinsight-service
MICROSERVICE_NAMEName of the microservice. Used for tracingstringAnyunited-manufacturing-hub-factoryinput
SERIAL_NUMBERSerial number of the cluster. Used for tracingstringAnydefault
VERSIONThe version of the API used. Each version also enables all the previous onesintAny1
Last modified May 5, 2023: feat: finishing touches (1147002)