https://github.com/rulanugrh/lysithea
Implementation of ELK Stack with Golang and PostgreSQL, as well as monitoring with Elastic APM Opentelemetry
https://github.com/rulanugrh/lysithea
elk-stack go-api go-elk
Last synced: 6 months ago
JSON representation
Implementation of ELK Stack with Golang and PostgreSQL, as well as monitoring with Elastic APM Opentelemetry
- Host: GitHub
- URL: https://github.com/rulanugrh/lysithea
- Owner: rulanugrh
- License: mit
- Created: 2024-02-18T14:33:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-05T13:55:29.000Z (over 1 year ago)
- Last Synced: 2025-02-14T21:00:05.535Z (8 months ago)
- Topics: elk-stack, go-api, go-elk
- Language: Go
- Homepage:
- Size: 1.07 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lysithea
## Getting Started
Haii, is my project, in this project about implementation ELK (Elasticsearch, Logstash, Kibana) stack. Before you running this project you must have :
- [Golang](https://go.dev/dl)
- [PostgreSQL](https://www.postgresql.org/download/)
- [API Client](https://www.postman.com/downloads/)
- [Docker](https://docs.docker.com/engine/install/)
## Tech Stack
- Golang
- PostgreSQL
- GORM (ORM)
- Docker
- Elasticsearch
- Kibana
- Logstash
- JWT (JSON Web Token)
- [Validator](https://github.com/go-playground/validator)
- Mux (Web Framework)
- Opentelemetry
- Elasticsearch APM
## Installation
Clone this project on your local laptop
```
git clone https://github.com/rulanugrh/lysithea
```
Go to project folder
```
cd lysithea
```
Install go modules
```
go mod tidy
```
## Before Running
You must running db, elasticsearch, kibana, and logstash.
```
docker compose up -d db
docker compose up -d elasticsearch
docker compose up -d kibana
docker compose up -d logstash
```
If you dont have docker you can install docker, see [Docker Docs](https://docs-docker-com.translate.goog/engine/install).
## Running
Copy `.env.example` to `.env`
```
cp .env.example .env
```
Make sure your PostgresQL is running and you have it setup, and then migrate struct
```
go run cmd/main.go migrate
```
After running migration you can seed data to db
```
go run cmd/main.go seeder
```
And last, you can running HTTP Server
```
go run cmd/main.go serve
```
## Docs
You can see docs in url `APP_URL:APP_PORT/docs/`
## Structure Directory
This project stucture i use, hmm It looks like this structure is familiar to your eyes
```
.
├── Dockerfile
├── LICENSE
├── README.md
├── cmd
│ └── main.go
├── docker-compose.yml
├── docs
│ ├── docs.go
│ ├── swagger.json
│ └── swagger.yaml
├── go.mod
├── go.sum
├── infrastructure
│ ├── elk
│ │ ├── Dockerfile
│ │ ├── logstash.yml
│ │ ├── pipeline.yml
│ │ ├── postgresql-42.7.1.jar
│ │ └── pusher.conf
│ └── nginx
│ └── nginx.conf
├── internal
│ ├── config
│ │ ├── app.go
│ │ ├── db.go
│ │ ├── elasticsearch.go
│ │ └── otelapm.go
│ ├── entity
│ │ ├── domain
│ │ │ ├── category.go
│ │ │ ├── order.go
│ │ │ ├── product.go
│ │ │ └── user.go
│ │ └── web
│ │ ├── response.go
│ │ └── response_data.go
│ ├── http
│ │ ├── category.go
│ │ ├── order.go
│ │ ├── product.go
│ │ └── user.go
│ ├── middleware
│ │ ├── cors.go
│ │ ├── jwt.go
│ │ ├── token.go
│ │ └── validation.go
│ ├── mocks
│ │ ├── category_repository_mock.go
│ │ └── user_repository_mock.go
│ ├── repository
│ │ ├── category.go
│ │ ├── order.go
│ │ ├── product.go
│ │ └── user.go
│ ├── route
│ │ ├── category.go
│ │ ├── order.go
│ │ ├── product.go
│ │ └── user.go
│ ├── service
│ │ ├── category.go
│ │ ├── order.go
│ │ ├── product.go
│ │ └── user.go
│ └── util
│ ├── migration.go
│ ├── pagination.go
│ ├── seeder.go
│ └── uuid.go
└── tests
├── category_repository_test.go
└── user_repository_test.go
```
## LICENSE
This project is licensed under the terms of the [MIT](./LICENSE) license.