admin_casts_service

README

Admin casts service

Content

• Configuration
  • Params info
    • Database config
    • Jaeger config
    • Prometheus config
    • Kafka reader config
    • time.Duration
    • Secure connection config
• Metrics
• Docs
• Author
• License

---

Configuration

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

DB_PASSWORD=Password

1. 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
addr	movies_service	MOVIES_SERVICE_ADDRESS	string	address of the movies service
connection_config	movies_service		nested yml configuration secure connection config
addr	movies_persons_service	MOVIES_PERSONS_SERVICE_ADDRESS	string	address of the movies service
connection_config	movies_persons_service		nested yml configuration secure connection config
db_config			nested yml configuration database config		configuration for database connection
jaeger			nested yml configuration jaeger config	configuration for jaeger connection
kafka_events_config			nested yml configuration kafka reader config	configuration for kafka connection

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

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

Kafka reader config

yml name	env name	param type	description	supported values
brokers		[]string, array of strings	list of all kafka brokers
group_id		string	id or name for consumer group
read_batch_timeout		time.Duration with positive duration	amount of time to wait to fetch message from kafka messages batch	supported values

time.Duration yaml supported values

A Duration value can be expressed in various formats, such as in seconds, minutes, hours, or even in nanoseconds. Here are some examples of valid Duration values:

• 5s represents a duration of 5 seconds.
• 1m30s represents a duration of 1 minute and 30 seconds.
• 2h represents a duration of 2 hours.
• 500ms represents a duration of 500 milliseconds.
• 100µs represents a duration of 100 microseconds.
• 10ns represents a duration of 10 nanoseconds.

Secure connection config

yml name	param type	description	supported values
dial_method	string	dial method	INSECURE,INSECURE_SKIP_VERIFY,CLIENT_WITH_SYSTEM_CERT_POOL
server_name	string	server name overriding, used when dial_method=CLIENT_WITH_SYSTEM_CERT_POOL

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.

---