Ozon Marketplace Workplace API

Задания 3. Описание реализации:

Имплементация ручек согласно п.6:

  • Вызовы логируются
  • Возвращаются пустые ответы

###Базовая версия задания:
Из корня bss-workplace-api запустить docker-compose:

$ docker-compose -f docker-compose-mini.yaml up

После запуска проверить работу gRPC можно скриптами: scripts/grpc_server_tests (используется grpcurl)

###Задание 9(со звездочкой):
Из корня bss-workplace-api запустить docker-compose:

$ docker-compose -f docker-compose-traefik.yaml up

После запуска проверить работу gateway можно скриптами: scripts/gw_server_tests (используется curl)
Также в этом варианте доступен swagger: Доступ из браузера по URL: http://0.0.0.0:8080/swagger


Build project

Local

For local assembly you need to perform

$ make deps # Installation of dependencies
$ make build # Build project

Running

For local development

$ docker-compose up -d

Services

Swagger UI

The Swagger UI is an open source project to visually render documentation for an API defined with the OpenAPI (Swagger) Specification

Grafana:

gRPC:

[I] ➜ grpc_cli call localhost:8082 DescribeWorkplaceV1 "id: 1"
connecting to localhost:8082
Rpc failed with status code 5, error message: workplace not found

Gateway:

It reads protobuf service definitions and generates a reverse-proxy server which translates a RESTful HTTP API into gRPC

[I] ➜ curl -s -X 'POST' \
  'http://localhost:8080/v1/workplaces' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "1"
}' | jq .
{
  "code": 5,
  "message": "workplace not found",
  "details": []
}

Metrics:

Metrics GRPC Server

Status:

Service condition and its information

  • http://localhost:8000
    • /live– Layed whether the server is running
    • /ready – Is it ready to accept requests
    • /version – Version and assembly information

Prometheus:

Prometheus is an open-source systems monitoring and alerting toolkit

Kafka

Apache Kafka is an open-source distributed event streaming platform used by thousands of companies for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications.

Kafka UI

UI for Apache Kafka is a simple tool that makes your data flows observable, helps find and troubleshoot issues faster and deliver optimal performance. Its lightweight dashboard makes it easy to track key metrics of your Kafka clusters – Brokers, Topics, Partitions, Production, and Consumption.

Jaeger UI

Monitor and troubleshoot transactions in complex distributed systems.

Graylog

Graylog is a leading centralized log management solution for capturing, storing, and enabling real-time analysis of terabytes of machine data.

PostgreSQL

For the convenience of working with the database, you can use the pgcli utility. Migrations are rolled out when the service starts. migrations are located in the ./migrations directory and are created using the goose tool.

$ pgcli "postgresql://docker:[email protected]:5432/bss_workplace_api"

Python client

$ python -m venv .venv
$ . .venv/bin/activate
$ make deps
$ make generate
$ cd pypkg/bss-workplace-api
$ python setup.py install
$ cd ../..
$ docker-compose up -d
$ python scripts/grpc_client.py

Thanks

GitHub

View Github