shortly

---

A link shortening service.

Intention was in creation of a simple functionality showcasing usage of Clean Architecture, Prometheus, Grafana and Alertmanager, and different types of storages.

Installation

Source

$ git clone https://github.com/vkuksa/shortly.git && cd shortly
$ make

Testing

$ make test

Prometheus

Supported metrics:

• shortly_http_request_count (Total number of requests by route)
• shortly_http_request_seconds (Total amount of request time by route, in seconds)
• shortly_error_count (Errors notification)

Grafana

Prometheus supported as datasource. Refer to ./grafana/provisioning/datasources/prometheus_ds.yml configuration file.

Alertmanager

Triggers upon alert of shortly_error_count with "internal" appears.

Important: Refer to ./prometheus/alertmanager.yml for setup of receiver.

Interfaces

Implement REST and GraphQL interfaces for data fetching

REST

Endpoints:

POST /links for retrieving encoded link

GET /links/{uuid} for retrieving link info

GET /{uuid} for re-dirrection   

Graphql

Endpoint: /graphql

Query or mutation is specified in "query" url parameter

Query example: /graphql?query={link(uuid:"aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS9tYXBz"){uuid,url,count,createdAt,expiresAt}}

Mutation example: /graphql?query=mutation+_{shorten(url:"https://google.com/"){uuid}}

Storages

Mongodb

Uses index creation for efficient lookup over uuid field

Inmem

Using SwissMap https://github.com/dolthub/swiss as a main storage