Sending logs to developers / DONE

Log analysis: If you have found a bug in the software, please report it within 24 hours so that we can review the logs and determine the cause.

Our software stack includes ElasticSearch and LogStash to collect logs. These logs do not contain private keys or passwords of your clients or administrators. The collection is conducted solely for the purpose of identifying and resolving errors. Logs are stored on our server for one month.

Disabling Log Transmission

If you wish to stop sending your server logs to our server, you need to execute a few commands on your server where the API service is hosted.

Important: Disabling log transmission will prevent our team from analyzing your server’s operation and identifying errors without direct access to your server.

Docker

1. Add lines to the /home/runner/api_server/.env file:

# .env

```bash
SEND_LOGS=false
SEND_METRICS=false
```

1. Restart the API service:

   docker restart exchanger-api

Sources

1. Go to the directory with the exchanger-api code

2. Open the .env file

3. Add a line at the end of the file:

# .env

```bash
SEND_LOGS=false
SEND_METRICS=false
```

1. Restart the $projectName-logstash service or all services:

   pm2 restart all 

The service that is responsible for sending logs is called: $projectName-logstash

pm2 status

Using Self-Hosted ELK

Note: To use your own servers for log collection and analysis, you must have ELK (ElasticSearch, LogStash, Kibana) installed and configured. Ensure that your ELK environment is set up securely to prevent unauthorized access.

Important: When using self-hosted ELK, our team will not be able to analyze your server’s performance or identify errors without direct access to your server or ELK system.

Configuration

1. Update the environment file /home/runner/api_server/.env :

# .env

```bash
LOGSTASH_INDEX="pm2"
LOGSTASH_TYPE="_doc"
LOGSTASH_URL="https://logstash.hostname"
```

These parameters must be set according to your environment.  

2. Restart the API service:

```bash
docker restart exchanger-api
```