LoggingServer

LoggingServer is a centralized logging service implemented in C# and .NET Core to manage your application logs effectively. It helps you to log, retrieve and monitor different types of logs conveniently.

Features

1. Supports different types of log messages (Debug, Info, Warning, Error, Fatal).
2. The server provides API endpoints to fetch log files based on the Host and Date.
3. Ability to receive log messages from clients and store them into log files.

API Endpoints

1. GET /{host} : Fetches a list of log files for a given host.
2. GET /{host}/{type} : Fetches logs of a specific type for a given host.
3. POST /{host}/{type} : Appends a new log message of a given type for a specified host.

Change the Port

You can change the default port in the appsettings.json file.

{
	"LoggingServer": {
		"Port": 5000 // Change the port here
	}
}

Client usage

A client-side JavaScript logging API is available. It logs different types of messages to the console, and also sends them to the LoggingServer.

Example usage:
You can include the logger using our CDN link in your HTML file or using ES6 Module import. Html:

<script src="https://cdn.jsdelivr.net/gh/drew-chase/LoggingServer@{version}/LoggingServer/wwwroot/js/Logger.js"></script>

or ES6 Module:

import Logger from 'https://cdn.jsdelivr.net/gh/drew-chase/LoggingServer@{version}/LoggingServer/wwwroot/js/Logger.js';

Note:

Make sure to replace {version} with the version of the logger that you are using.

const logger = new Logger('https://your-loggingservice-host.com');
logger.info('This is an information message');
logger.error('An error occurred');

How to Use

You can make HTTP requests to the provided endpoint including the host and type of log as parameters in the URL and the log message in the request body.

POST /your-host/INFO
Content-Type: application/json

{
  "message": "Your log message"
}

You will receive a confirmation response upon the successful logging of the message.

Note:

• The host in the context of this server refers to the hostname of the user of the logging server where the logs originate from. The date is optional in the queryParams. If the date is not provided, the current date will be used to search the logs.
• Make sure to replace 'your-host' and 'INFO' with your host name and desired log type.

NGINX Configuration

map $http_connection $connection_upgrade {
    "~*Upgrade" $http_connection;
    default keep-alive;
}
server {
    listen 80;
    listen 443 ssl http2;
    listen [::]:443 ssl http2;
    listen [::]:80;
    server_name logging.example.com;

    location / {
        proxy_pass http://127.0.0.1:5000/;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

Apache Configuration

<VirtualHost *:80>
    ServerName logging.example.com

    <Location />
        # ProxyPass to your .NET Core App
        ProxyPassReverse http://127.0.0.1:5000
        ProxyPassReverse http://127.0.0.1:5000

        # Ensure that Apache will pass the host header
        ProxyPreserveHost On

        # Optional: Set maximum transmission time
        ProxyTimeout 600
    </Location>

    ErrorLog ${APACHE_LOG_DIR}/logging_error.log
    CustomLog ${APACHE_LOG_DIR}/logging_access.log combined
</VirtualHost>

Windows

Just run the executable file.

Linux Service

Create a systemd service file to run the LoggingServer as a service. File path: /etc/systemd/system/logging-server.service and write this:

[Unit]
Description=HTTP Logging Server
After=network.target
StartLimitIntervalSec=0

[Service]
Type=simple
Restart=always
RestartSec=1
User=www-data # Change this to your user
WorkingDirectory=/path/to/LoggingServer/
ExecStart=/path/to/LoggingServer/LoggingServer

[Install]
WantedBy=multi-user.target

Then run the following commands:

Reload the systemd daemon:

sudo systemctl daemon-reload

Enable the service (to start on boot):

sudo systemctl enable logging-server

Start the service:

sudo systemctl start logging-server