Skip to content

Commit

Permalink
Update README.md, added configuration params info
Browse files Browse the repository at this point in the history
  • Loading branch information
Falokut committed Dec 16, 2023
1 parent 5376b32 commit b416da6
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,42 @@
# Content
+ [Images storage service](#images-storage-service)
+ [Docs](#swagger-docs)
+ [Params info](#configuration-params-info)
+ [Jaeger config](#jaeger-config)
+ [Prometheus config](#prometheus-config)
+ [Author](#author)
+ [License](#license)

# Configuration params info
if supported values is empty, then any type values are supported

| yml name | yml section | env name | param type| description | supported values |
|-|-|-|-|-|-|
| log_level | | LOG_LEVEL | string | logging level | panic, fatal, error, warning, warn, info, debug, trace|
| healthcheck_port | | HEALTHCHECK_PORT | string | port for healthcheck| any valid port that is not occupied by other services. The string should not contain delimiters, only the port number|
| base_local_storage_path | | BASE_LOCAL_STORAGE_PATH | string |path of images storage(relative or absolute path)||
| max_image_size | | MAX_IMAGE_SIZE | int |max image size in bytes| only positive values|
| host | listen | HOST | string | ip address or host to listen | |
| port | listen | PORT | string | port to listen | The string should not contain delimiters, only the port number|
| server_mode | listen | SERVER_MODE | string | Server listen mode, Rest API, gRPC or both | GRPC, REST, BOTH|
|service_name| prometheus | PROMETHEUS_SERVICE_NAME | string | service name, thats will show in prometheus ||
|server_config| prometheus | | nested yml configuration [metrics server config](#prometheus-config) | |
|jaeger|||nested yml configuration [jaeger config](#jaeger-config)|configuration for jaeger connection ||

## Jaeger config

|yml name| env name|param type| description | supported values |
|-|-|-|-|-|
|address|JAEGER_ADDRESS|string|ip address(or host) with port of jaeger service| all valid addresses formatted like host:port or ip-address:port |
|service_name|JAEGER_SERVICE_NAME|string|service name, thats will show in jaeger in traces||
|log_spans|JAEGER_LOG_SPANS|bool|whether to enable log scans in jaeger for this service or not||

## Prometheus config
|yml name| env name|param type| description | supported values |
|-|-|-|-|-|
|host|METRIC_HOST|string|ip address or host to listen for prometheus service||
|port|METRIC_PORT|string|port to listen for of prometheus service| any valid port that is not occupied by other services. The string should not contain delimiters, only the port number|

# Docs
[Swagger docs](swagger/docs/images_storage_service_v1.swagger.json)

Expand Down

0 comments on commit b416da6

Please sign in to comment.