Discord Message Logger

A discord bot that logs all messages in channels and stores them in MongoDB database, providing both Discord slash commands and REST API endpoints for querying the data.

Features

🤖 Discord Bot Integration: Automatically logs all messages from Discord channels
📊 Message Analytics: Get statistics about channel activity and user participation
🔍 Advanced Search: Search through message history with full-text search
🌐 REST API: Access logged data via comprehensive REST endpoints
📱 Slash Commands: Query data directly from Discord using / commands
🐳 Docker Support: Easy deployment with Docker and Docker Compose
🔒 Production Ready: Includes security best practices and secrets management
📈 Scalable Architecture: Built with Spring Boot and MongoDB for high performance

Tech Stark

Backend: Kotlin + Spring Boot 3.4.0
Database: MongoDB 7 with optimized indexes
Discord: JDA (Java Discord API) 5.0.0
Containerization: Docker & Docker Compose V2
Database Management: Mongo Express (optional)
Testing: JUnit 5 + MockK
Architecture: MVC pattern with service layer

Quick Start

Prerequisites

Java 21
Docker & Docker Compose V2
Discord Bot Token

1. Setup Discord Bot

Go to the Discord Developer Portal.
Click New Application → give your bot a name (e.g. LoggerBot).
In the sidebar, go to Bot → click Add Bot.
Under Token, click Reset Token → copy the token.
- ⚠️ Treat this like a password, never commit it to Git.
Enable Privileged Gateway Intents (required to read messages):
- MESSAGE CONTENT INTENT
- SERVER MEMBERS INTENT
Go to OAuth2 → URL Generator:
- Under Scopes, check bot and applications.commands.
- Under Bot Permissions, enable:
  - Read Messages/View Channels
  - Read Message History
  - Send Messages
  - Use Slash Commands
- Copy the generated URL and open it in a browser. Select the server to invite your bot.

2. Environment Configuration

Copy the example environment file:

cp .env.example .env

Edit .env and add your Discord bot token:

DISCORD_BOT_TOKEN=your-discord-bot-token-here
MONGODB_PASSWORD=your-secure-password

⚠️ Important: Avoid special characters like @, :, or / in MongoDB passwords as they can cause connection string parsing issues. Use alphanumeric characters and underscores instead.

3. Run with Docker

# Start core services (MongoDB + Discord Logger)
docker compose up -d

# Start with optional services (includes Mongo Express for database management)
docker compose --profile tools up -d

# View logs
docker compose logs -f discord-logger

# Stop services
docker compose down

4. Invite Bot to Server

Use this URL (replace CLIENT_ID and PERMISSIONS with your bot's client ID):

https://discord.com/api/oauth2/authorize?client_id=YOUR_CLIENT_ID&permissions=PERMISSIONS&scope=bot%20applications.commands

Database Management

Mongo Express (Optional)

The project includes Mongo Express, a web-based MongoDB admin interface, as an optional service:

# Start with Mongo Express enabled
docker compose --profile tools up -d

# Access Mongo Express at http://localhost:8081
# Default credentials: admin / admin123

Features:

Browse and edit database collections
Execute MongoDB queries
View database statistics
Import/export data

Configuration: Update these variables in your .env file:

MONGO_EXPRESS_PORT=8081
MONGO_EXPRESS_USER=admin
MONGO_EXPRESS_PASSWORD=your-admin-password

Discord Commands

The bot provides these slash commands:

Command	Description	Usage
`/stats`	Get channel statistics	`/stats`
`/search`	Search messages	`/search query:hello world`
`/recent`	Get recent messages	`/recent hours:24`
`/user-messages`	Get messages from user	`/user-messages user:@username`

REST API

The application exposes REST endpoints at http://localhost:8080/api/messages:

Endpoints

# Get messages by channel
GET /api/messages/channel/{channelId}?page=0&size=20&sort=timestamp,desc

# Get messages by author
GET /api/messages/author/{authorId}?page=0&size=20

# Search messages
GET /api/messages/search?query=hello&page=0&size=20

# Get recent messages
GET /api/messages/recent?since=2024-01-01T00:00:00

# Get channel statistics
GET /api/messages/stats/channel/{channelId}

# Health check
GET /api/messages/health

Example Response

{
  "content": [
    {
      "id": "507f1f77bcf86cd799439011",
      "messageId": "1234567890123456789",
      "channelId": "987654321098765432",
      "channelName": "general",
      "guildId": "111222333444555666",
      "guildName": "My Discord Server",
      "authorId": "123456789012345678",
      "authorName": "JohnDoe",
      "authorDiscriminator": "0001",
      "content": "Hello, world!",
      "timestamp": "2024-01-15T10:30:00",
      "isBot": false,
      "messageType": "DEFAULT"
    }
  ],
  "totalElements": 150,
  "totalPages": 8,
  "number": 0,
  "size": 20
}

Development

Local Development Setup

Clone the repository:

git clone <repository-url>
cd discord-message-logger

Set up MongoDB (if not using Docker):

# Install MongoDB locally or use MongoDB Atlas
# Create database: discord-messages

Configure application.properties:

discord.bot.token=your-bot-token
spring.data.mongodb.uri=mongodb://localhost:27017/discord-messages

Run the application:

./gradlew bootRun

Run tests:

./gradlew test

Building

# Build JAR
./gradlew build

# Build Docker image
docker build -t discord-message-logger .

# Build and start services
docker compose up -d --build

Production Deployment

Using Docker Secrets

For production environments, use Docker secrets:

Create secret files:

echo "your-bot-token" | docker secret create discord_bot_token -
echo "production-db-password" | docker secret create mongodb_password -

Deploy with production compose:

docker compose -f docker-compose.prod.yml up -d

Configuration Options

Environment Variable	Description	Default
`DISCORD_BOT_TOKEN`	Discord bot token	Required
`MONGODB_USERNAME`	MongoDB admin username	`admin`
`MONGODB_PASSWORD`	MongoDB admin password	`password123`
`MONGODB_DATABASE`	MongoDB database name	`discord-messages`
`MONGODB_PORT`	MongoDB port	`27017`
`APP_PORT`	Application port	`8080`
`SPRING_PROFILES_ACTIVE`	Spring active profiles	`docker`
`JAVA_OPTS`	JVM options	`-Xmx512m -Xms256m`
`MONGO_EXPRESS_PORT`	Mongo Express port	`8081`
`MONGO_EXPRESS_USER`	Mongo Express username	`admin`
`MONGO_EXPRESS_PASSWORD`	Mongo Express password	`admin123`

Architecture

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Discord API   │◄──►│  Message        │◄──►│    MongoDB      │
│                 │    │  Listener       │    │                 │
└─────────────────┘    └─────────────────┘    └─────────────────┘
                              │
                              ▼
                       ┌─────────────────┐
                       │   Service       │
                       │   Layer         │
                       └─────────────────┘
                              │
                    ┌─────────┼─────────┐
                    ▼         ▼         ▼
            ┌──────────┐ ┌──────────┐ ┌──────────┐
            │   REST   │ │  Slash   │ │   Web    │
            │   API    │ │ Commands │ │    UI    │
            └──────────┘ └──────────┘ └──────────┘

Database Schema

Messages Collection

{
  _id: ObjectId,
  messageId: String,        // Discord message ID (unique)
  channelId: String,        // Discord channel ID  
  channelName: String,      // Channel name
  guildId: String,          // Discord guild/server ID
  guildName: String,        // Guild/server name
  authorId: String,         // Message author ID
  authorName: String,       // Author username
  authorDiscriminator: String, // Author discriminator
  content: String,          // Message content
  timestamp: Date,          // When message was sent
  editedTimestamp: Date,    // When message was edited (optional)
  attachments: Array,       // File attachments
  embeds: Array,           // Rich embeds
  reactions: Array,        // Message reactions
  isBot: Boolean,          // Whether author is a bot
  messageType: String      // Message type (DEFAULT, REPLY, etc.)
}

Indexes

The application creates optimized indexes for fast queries:

messageId (unique)
channelId + timestamp (compound)
authorId + timestamp (compound)
timestamp (descending)
content (text search)

Monitoring

Health Checks

Application: GET /api/messages/health
Docker Health: Built-in container health checks
MongoDB: Database connection monitoring

Logging

Application logs are written to ./logs/ directory
Docker containers use JSON file logging with rotation
Log levels configurable via application.properties

Security Considerations

✅ Non-root user in Docker containers
✅ Secrets management with Docker secrets
✅ Environment variable configuration
✅ Input validation on all endpoints
✅ CORS configuration for API endpoints
✅ Database connection with authentication

Contributing

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'feat: add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Please follow the conventional commits specification.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions:

Check the troubleshooting guide
Search existing GitHub issues
Create a new issue with detailed information

⭐ If you find Discord Message Logger helpful, please star this repository to support the project!

Made with ❤️ by developers, for developers

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Discord Message Logger

Features

Tech Stark

Quick Start

Prerequisites

1. Setup Discord Bot

2. Environment Configuration

3. Run with Docker

4. Invite Bot to Server

Database Management

Mongo Express (Optional)

Discord Commands

REST API

Endpoints

Example Response

Development

Local Development Setup

Building

Production Deployment

Using Docker Secrets

Configuration Options

Architecture

Database Schema

Messages Collection

Indexes

Monitoring

Health Checks

Logging

Security Considerations

Contributing

License

Support

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Discord Message Logger

Features

Tech Stark

Quick Start

Prerequisites

1. Setup Discord Bot

2. Environment Configuration

3. Run with Docker

4. Invite Bot to Server

Database Management

Mongo Express (Optional)

Discord Commands

REST API

Endpoints

Example Response

Development

Local Development Setup

Building

Production Deployment

Using Docker Secrets

Configuration Options

Architecture

Database Schema

Messages Collection

Indexes

Monitoring

Health Checks

Logging

Security Considerations

Contributing

License

Support