Image Processing Service

The Image Processing Service is a simple image processing service with gRPC and RestAPI endpoints.

Content

• Image Processing Service
• Running instructions
• Params info
  • Jaeger config
  • Prometheus config
• Documentation
• Used modules
• Author
• License

How to Run

• clone git repo

    git clone https://github.com/Falokut/image_processing_service.git

• create config file config.yml in dir ./config
• provide config by docker compose volume
• run by command

    docker compose up --build

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
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
max_request_size	listen	MAX_REQUEST_SIZE	int32	max request size in mb, by default 4 mb	only > 0
max_response_size	listen	MAX_RESPONSE_SIZE	int32	max response size in mb, by default 4 mb	only > 0
server_mode	listen	SERVER_MODE	string	Server listen mode, Rest API, gRPC or both	GRPC, REST, BOTH
enable_metrics		ENABLE_METRICS	bool	enable metrics report or not, if true, prometheus and jaeger metrics configs will be ignored
service_name	prometheus	PROMETHEUS_SERVICE_NAME	string	service name, thats will show in prometheus
server_config	prometheus		nested yml configuration metrics server config
jaeger			nested yml configuration 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

Used modules

• imaging for image encoding/decoding
• mimetype for types detection
• bild for images processing

Author

• @Falokut - Primary author of the project

License

This project is licensed under the terms of the MIT License.

---