oneuptime/InfrastructureAgent/README.md
Simon Larsen 9791aa1259
chore: Add CPU core count to CPUMetrics
This commit adds the `cores` field to the `CPUMetrics` struct in order to include the number of CPU cores in the collected metrics. This information is useful for understanding the processing power of the server.
2024-07-02 13:54:04 +01:00

1.6 KiB

OneUptime Infrastructure Agent

The OneUptime Infrastructure Agent is a lightweight, open-source agent that collects system metrics and sends them to the OneUptime platform. It is designed to be easy to install and use, and to be extensible.

Installation

curl -s https://oneuptime.com/docs/static/scripts/infrastructure-agent/install.sh | bash

Configure the agent

Configure the agent as a system service

  • You can change the host to your own host if you're self hosting the OneUptime platform.
  • You can find the secret key on OneUptime Dashboard. Click on "View Monitor" and go to "Settings" tab.
oneuptime-infrastructure-agent configure --secret-key=YOUR_SECRET_KEY --oneuptime-url=https://oneuptime.com

Starting the agent

oneuptime-infrastructure-agent start

Once its up and running you should see the metrics on the OneUptime Dashboard.

Stopping the agent

oneuptime-infrastructure-agent stop

Restarting the agent

oneuptime-infrastructure-agent restart

Uninstalling the agent

oneuptime-infrastructure-agent uninstall && rm -rf /usr/bin/oneuptime-infrastructure-agent

Supported Platforms

  • Linux
  • MacOS
  • Windows

Development

This section is for developers who want to contribute to the agent. The agent is written in Go.

Building the agent

go build

Configure the agent

sudo ./oneuptime-infrastructure-agent configure --secret-key=YOUR_SECRET_KEY --oneuptime-url=https://localhost

Starting the agent

sudo ./oneuptime-infrastructure-agent start

Stopping the agent

sudo ./oneuptime-infrastructure-agent stop