A simple service that shortens URLs. My first practice with gRPC.
To shorten URL, this service stores original URL in PostgreSQL and encodes ID into base62.
To unshorten URL, it decodes base62 and tries to get original URL by code from cache (Valkey). If not in cache, it queries the PostgreSQL.
It is a Kafka producer for topics shortener.shortened and shortener.unshortened.
It is a Kafka consumer for topic shortened.top_unshortened.
This service gets a top of URLs by clicks for the last time (configured in .env) from Kafka and stores these URLs in Valkey with configured TTL.
This service communicates with the shortener by gRPC.
To shorten URL, it gets base62 encoded id from shortener and constructs final URL using PUBLIC_HOST and base62. For example, base62 is 1z, PUBLIC_HOST is https://sh.some/. Final URL is https://sh.some/1z.
To unshorten URL, it queries the shortener and gets original URL by base62 in the path param in the request. Then, it redirects with 302 to the original URL.
This service also communicates with the shortener by gRPC.
Bot only shortens the URL, unshortening process is on gateway.
Shortening process is the same as the one in gateway: walk to the shortener, get base62, connect public host.
It takes the URL in inline mode. For example, @mybot https://github.com/misshanya/url-shortener. And you will get the shortened URL.
This service is a Kafka consumer for 2 topics: shortener.shortened and shortener.unshortened.
It gets events, logs them, stores in ClickHouse and increments Prometheus counters.
Statistics service has a background goroutine to get top of the URLs by clicks from ClickHouse for the last time.
It sends this top to Kafka.
This strategy helps to cache URLs in the shortener service.
- Go
- PostgreSQL
- Valkey (Cache)
- ClickHouse
- Kafka (UI is available on port 8088)
- Prometheus
- Grafana (available on port 8089)
- Docker
- Go 1.24+ (if you want to build without Docker)
- Telegram bot token
Clone repo and cd into it
git clone https://github.com/misshanya/url-shortener
cd url-shortenerCopy .env.example to the .env file and edit it with your preferences (like public url and bot token)
cp .env.example .envRun!
docker compose up -dShorten - POST /shorten with the following body:
{
"url": "your-url-to-shorten"
}Unshorten - GET /{base62}
This project is licensed under the MIT license. See the LICENSE file for details.