Skip to content

Latest commit

 

History

History
102 lines (80 loc) · 2.33 KB

README.md

File metadata and controls

102 lines (80 loc) · 2.33 KB
Raw

Go Report Card Go

URL Shortener Service

URL Shortener service in Go. Functionality:

  • Create/Describe/Delete shortened urls
  • Redirect shortened urls to Original
  • Check statistic: redirections count, lastRedirectTime

API Documentation

SwaggerHub
https://app.swaggerhub.com/apis/vrazdalovschi/url-shortener/0.1.0-oas3

API docs are available by swagger (api/swagger.yaml). Just deploy using docker-compose:

Api Definition

http://localhost:8080/swaggerui/swagger.yaml

SwaggerUi

http://localhost:8080/swagger/index.html

Run

Run with Docker (deployments folder)

cd deployments
docker-compose up -d --build

Assumptions and expected environment

Project is developed in GO 1.14 an instance with go 1.14 is expected

Configuration options

Available using first flags if not set then env variable

HTTP_ADDR    -  Endpoint port (default value :8080)

Postgres related

DB_HOST       - Database Host. Default: localhost
DB_PORT       - Database Port. Default: 5432
DB_USER       - Database User. Default: url-shortener
DB_PASSWORD   - Database Password. Default: root
DB_NAME       - Database Name. Default: shortener

Storage

Postgres is chosen for storage purposes.

Schema definition

Tables are auto created on starting the project.

Urls table.

CREATE TABLE IF NOT EXISTS url 
  ( 
     shortenedid    VARCHAR NOT NULL UNIQUE, 
     originalurl    VARCHAR NOT NULL, 
     apikey         VARCHAR NOT NULL, 
     creationtime   TIMESTAMP NOT NULL, 
     expirationdate TIMESTAMP NOT NULL 
  );

Statistics table.

CREATE TABLE IF NOT EXISTS stats 
  ( 
     shortenedid VARCHAR NOT NULL UNIQUE, 
     redirects   INTEGER DEFAULT 0, 
     visitdate   TIMESTAMP 
  );

Known issues

  • Test Coverage
  • Better error handling
  • Distributed caching
  • SQL Schema migration

Instrumentation

Prometheus metrics:

  • System load
  • Latency summary per each api call (success/error)
  • Counter for each api call (success/error)
http://localhost:8080/internal/metrics