Content

• Configuration
  • Params info
    • Database config
    • Jaeger config
    • Prometheus config
    • Secure connection config
• Related services
• Metrics
• Docs
• Author
• License

---

Configuration

1. Configure movies_persons_db
2. Create .env on project root dir
   Example env:

DB_PASSWORD=Password

3. Create a configuration file or change the config.yml file in docker\containers-configs. If you are creating a new configuration file, specify the path to it in docker-compose volume section (your-path/config.yml:configs/)

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
server_mode	listen	SERVER_MODE	string	Server listen mode, Rest API, gRPC or both	GRPC, REST, BOTH
allowed_headers	listen		[]string, array of strings	list of all allowed custom headers. Need for REST API gateway, list of metadata headers, hat are passed through the gateway into the service	any strings list
service_name	prometheus	PROMETHEUS_SERVICE_NAME	string	service name, thats will show in prometheus
server_config	prometheus		nested yml configuration metrics server config
db_config			nested yml configuration database config		configuration for database connection
jaeger			nested yml configuration jaeger config	configuration for jaeger connection
storage_addr	image_storage_service	IMAGE_STORAGE_ADDRESS	string	ip address(or host) with port of image storage service service	all valid addresses formatted like host:port or ip-address:port
connection_config	image_storage_service		nested yml configuration secure connection config
base_photo_url	image_storage_service	BASE_PHOTO_URL	string	url for getting a photo
photo_category	image_storage_service	PHOTO_CATEGORY	string	category on storage for photo
addr	image_processing_service	IMAGE_PROCESSING_ADDRESS	string	category on storage for photo
connection_config	image_processing_service		nested yml configuration secure connection config
resize_type	image_processing_service	RESIZE_TYPE	string	resizing method for photo	Box,CatmullRom,Lanczos,Linear,MitchellNetravali,NearestNeighbor
photo_height	image_processing_service	PHOTO_HEIGHT	int32	photo height after resize	only positive values of int32
photo_width	image_processing_service	PHOTO_WIDTH	int32	photo width after resize	only positive values of int32
allowed_types	image_processing_service		[]string, array of strings	allowed images mime types	only images mime types (like image/png)
max_image_width	image_processing_service	MAX_IMAGE_WIDTH	int32	max photo width	only positive values of int32
max_image_height	image_processing_service	MAX_IMAGE_HEIGHT	int32	max photo height	only positive values of int32
min_image_width	image_processing_service	MIN_IMAGE_WIDTH	int32	min photo width	only positive values of int32
min_image_height	image_processing_service	MIN_IMAGE_HEIGHT	int32	min photo height	only positive values of int32

Database config

yml name	env name	param type	description	supported values
host	DB_HOST	string	host or ip address of database
port	DB_PORT	string	port of database	any valid port that is not occupied by other services. The string should not contain delimiters, only the port number
username	DB_USERNAME	string	username(role) in database
password	DB_PASSWORD	string	password for role in database
db_name	DB_NAME	string	database name (database instance)
ssl_mode	DB_SSL_MODE	string	enable or disable ssl mode for database connection	disabled or enabled
enable_prepared_statements	DB_ENABLE_PREPARED_STATEMENTS	bool	enable or disable prepared statements, if you use PgBouncer, disable it or use server_reset_query = DISCARD ALL in pgbouncer.ini in [pgbouncer] section	true or false
brokers	kafka		[]string, array of strings	list of all kafka brokers

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

Secure connection config

yml name	param type	description	supported values
dial_method	string	dial method	INSECURE,NIL_TLS_CONFIG,CLIENT_WITH_SYSTEM_CERT_POOL,SERVER
server_name	string	server name overriding, used when dial_method=CLIENT_WITH_SYSTEM_CERT_POOL
cert_name	string	certificate file name, used when dial_method=SERVER
key_name	string	key file name, used when dial_method=SERVER

Related Services

• Images storage service
• Image processing service

Metrics

The service uses Prometheus and Jaeger and supports distribution tracing

Docs

Swagger docs

Author

• @Falokut - Primary author of the project

License

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

---