https://github.com/balena-io-examples/device-cloud-logging

An example of using the journald log streaming endpoint on balena-supervisor
https://github.com/balena-io-examples/device-cloud-logging

Last synced: 22 days ago
JSON representation

An example of using the journald log streaming endpoint on balena-supervisor

• Host: GitHub
• URL: https://github.com/balena-io-examples/device-cloud-logging
• Owner: balena-io-examples
• Created: 2019-08-21T14:03:56.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-21T14:04:16.000Z (over 5 years ago)
• Last Synced: 2024-05-29T22:15:28.245Z (7 months ago)
• Language: Shell
• Size: 50.8 KB
• Stars: 10
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Storing a balena device's journal logs

This project is an example of how to persist a device's

journal logs to either the disk, or the [loggly cloud service](https://www.loggly.com/).

Note that this project should be used as an example only,

and the methods used to post logs to loggly are inefficient.

No log rotation is implemented if the project is not using

the loggly backend, which means that the device file system

can fill up over time.

This project requires a device running balena-supervisor

version >= v10.3.0.

## Usage

Create an application on the [balena dashboard](https://dashboard.balena-cloud.com), with the

device type you plan to use. We will assume an application

name of `logging-app` for the rest of this usage

explanation.

Push this project to an application using

[balena-cli](https://github.com/balena-io/balena-cli):

```bash

$ balena push logging-app

```

### Saving logs to disk

By default this project will write the journal logs to disk.

The location of these logs will be `/logs/log.journal` in

the `log-gatherer` container. This location is actually the

mount point of the docker volume `log-volume`, defined in

our `docker-compose.yml` file.

### Exporting logs to the loggly service

This option requires a loggly account, and the HTTPS

endpoint available from the loggly dashboard:

![loggly-dashboard](images/loggly-endpoint.png)

Take this URL and assign it to the device environment

variable `LOGGLY_URL` on the balena dashboard. This will

cause the service to restart and the logs will instead be

streamed to loggly, and not saved on disk.