Simple Observability

https://simpleobservability.com/docs
Admin
Simple Observability is a lightweight monitoring platform with a single agent that collects system...
Tokens:8,167
Snippets:167
Trust Score:6.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Recommended Linux Installation

Source: https://simpleobservability.com/docs/installation

Installs the simob agent using a script. Replace <SERVER_KEY> with your actual server key. This method automates binary download, installation, user creation, and systemd service setup.

```bash
curl -fsSL https://install.simpleobservability.com/install.sh | sudo bash -s <SERVER_KEY>
```

--------------------------------

### Initialize Simple Observability Agent

Source: https://simpleobservability.com/docs/usage

Performs setup tasks like creating a configuration file, discovering metrics and log sources, and gathering host information. This command is often executed during installation.

```bash
simob init
```

--------------------------------

### Install simob on Windows (Administrator PowerShell)

Source: https://simpleobservability.com/docs/installation

Installs the simob agent on Windows by downloading and executing an install script. Requires Administrator privileges and a server key.

```powershell
iwr 'https://simpleobservability.com/install.ps1' -OutFile "$env:TEMP\install.ps1"; & "$env:TEMP\install.ps1" -ApiKey <SERVER_KEY>
```

--------------------------------

### Linux Non-sudo Installation (Testing)

Source: https://simpleobservability.com/docs/installation

Installs the simob agent without sudo, suitable for testing. It installs the binary in the user's home directory and skips systemd service creation. The agent will not run as a persistent daemon.

```bash
curl -fsSL https://install.simpleobservability.com/install.sh | bash -s -- --no-sudo <SERVER_KEY>
```

--------------------------------

### Start Simple Observability Agent Service

Source: https://simpleobservability.com/docs/usage

Manually starts the collection service. Typically used internally by systemd; for regular operation, use systemd commands like `sudo systemctl start simob`.

```bash
simob start
```

--------------------------------

### Start simob Service

Source: https://simpleobservability.com/docs/installation

If the agent is not running, use this command to start the simob service managed by systemd. This is typically required after troubleshooting.

```bash
sudo systemctl start simob
```

--------------------------------

### Remove simob Binary and Configuration (sudo install)

Source: https://simpleobservability.com/docs/installation

Deletes the simob agent's installation directory and binary file when installed with sudo. This is a key step in the uninstallation process.

```bash
sudo rm -rf /opt/simob
sudo rm /usr/local/bin/simob
```

--------------------------------

### Check Simple Observability Agent Version

Source: https://simpleobservability.com/docs/usage

Displays the currently installed version of the agent.

```bash
simob version
```

--------------------------------

### Remove simob Binary and Configuration (non-sudo install)

Source: https://simpleobservability.com/docs/installation

Deletes the simob agent's installation directory and binary file when installed without sudo, typically from the user's local directory.

```bash
rm -rf $HOME/.local/simob
rm $HOME/.local/bin/simob
```

--------------------------------

### PHP-FPM Pool Configuration Example

Source: https://simpleobservability.com/docs/metrics/phpfpm

Configure your PHP-FPM pool to enable the status endpoint and expose it locally. Ensure the pool listens on the default address and port used by the agent.

```ini
[www]
listen = 127.0.0.1:9000
pm.status_path = /status

```

--------------------------------

### Stop and Disable simob Service

Source: https://simpleobservability.com/docs/installation

Commands to stop the simob service and prevent it from starting automatically on boot. This is part of the uninstallation process for systemd-managed installations.

```bash
sudo systemctl stop simob
sudo systemctl disable simob
```

--------------------------------

### Verify Memcached Endpoint with Memstat

Source: https://simpleobservability.com/docs/metrics/memcached

Utilize the 'memstat' command-line tool to check Memcached server statistics. Ensure the 'libmemcached-tools' package is installed.

```bash
memstat --servers=127.0.0.1
```

--------------------------------

### Update Simple Observability Agent

Source: https://simpleobservability.com/docs/usage

Checks for and installs newer versions of the agent. The update process restarts the agent service, causing a brief interruption in data collection.

```bash
simob update
```

--------------------------------

### Check Agent Status (simob status)

Source: https://simpleobservability.com/docs/installation

Use this command to check if the simob agent is actively running as a background daemon. This is useful after installation or restarts.

```bash
simob status
```

--------------------------------

### Remove simob Installation Directory on Windows

Source: https://simpleobservability.com/docs/installation

Removes the simob agent's installation directory from Program Files. This is the final step in uninstalling the agent on Windows.

```powershell
Remove-Item -Recurse -Force "C:\Program Files\SimpleObservability\simob"
```

--------------------------------

### Systemd Service Configuration with System-wide Read Access

Source: https://simpleobservability.com/docs/installation

Adds system-wide read access capabilities to the simob agent's systemd service configuration. This is typically added by default unless the --no-system-read flag is used during installation.

```ini
# Grant read/search access to the filesystem (bypassing some permission checks)
AmbientCapabilities=CAP_DAC_READ_SEARCH
CapabilityBoundingSet=CAP_DAC_READ_SEARCH
```

--------------------------------

### Disable Telemetry

Source: https://simpleobservability.com/docs/installation

Disables sending anonymized error telemetry messages during installation by setting the SKIP_TELEMETRY environment variable.

```bash
SKIP_TELEMETRY=1 curl -fsSL https://install.simpleobservability.com/install.sh | sudo bash -s <SERVER_KEY>
```

--------------------------------

### View Simple Observability Agent Configuration

Source: https://simpleobservability.com/docs/usage

Outputs the current resolved configuration, useful for debugging, validation, and troubleshooting configuration issues.

```bash
simob config
```

--------------------------------

### Follow Live Agent Logs

Source: https://simpleobservability.com/docs/installation

Monitor the simob agent's logs in real-time using journalctl with the -f flag. This is useful for diagnosing issues during agent startup or operation.

```bash
sudo journalctl -u simob -f
```

--------------------------------

### Invite App to Slack Channel

Source: https://simpleobservability.com/docs/alerts/slack

Use this command within a Slack channel to allow the Simple Observability app to post messages there. Ensure the app is already connected to your workspace.

```bash
/invite @SimpleObservability
```

--------------------------------

### Configure NGINX Stub Status

Source: https://simpleobservability.com/docs/metrics/nginx

Create a minimal NGINX server configuration to expose statistics via the stub_status module. This configuration should be placed in a file like `/etc/nginx/sites-enabled/status.conf`.

```nginx
server {
    listen 127.0.0.1:80;
    listen [::1]:80;

    location /nginx_status {
        stub_status on;
        allow 127.0.0.1;
        allow ::1;
        deny all;
    }
}
```

--------------------------------

### Check Agent Status (systemd)

Source: https://simpleobservability.com/docs/installation

If using systemd, this command provides detailed status information about the simob service, including whether it is active and running.

```bash
systemctl status simob
```

--------------------------------

### Systemd Service Configuration

Source: https://simpleobservability.com/docs/installation

Default systemd service file configuration for the simob agent. This configuration includes security hardening options and capabilities.

```ini
[Unit]
Description=simob daemon
After=network.target

[Service]
Type=simple
ExecStart=<INSTALL PATH> start
Restart=always
User=<USER USED>
Group=<GROUP USED>
# Prevent gaining any further privileges
NoNewPrivileges=yes
# Mount /usr, /boot, /etc read-only
ProtectSystem=full
# Isolate /home, /root, /run/user
ProtectHome=yes
# Private /tmp and /var/tmp
PrivateTmp=true

[Install]
WantedBy=multi-user.target
```

--------------------------------

### View Recent Agent Logs

Source: https://simpleobservability.com/docs/installation

Access recent logs for the simob agent using journalctl. This command is essential for diagnosing startup errors or configuration issues, showing logs from the last 10 minutes.

```bash
sudo journalctl -u simob --since "10 minutes ago"
```

--------------------------------

### Verify Memcached Endpoint with Netcat

Source: https://simpleobservability.com/docs/metrics/memcached

Use netcat to manually send the 'stats' command to a Memcached instance and verify its response. This is useful for troubleshooting connectivity issues.

```bash
echo "stats" | nc 127.0.0.1 11211
```

--------------------------------

### Verify Apache Log File Access

Source: https://simpleobservability.com/docs/logs/apache

Use this command to manually check if the simob-agent user has read permissions for the Apache access log. This is crucial for log collection.

```bash
sudo -u simob-agent tail -n 1 /var/log/apache2/access.log
```

--------------------------------

### Configure Apache Status Handler

Source: https://simpleobservability.com/docs/metrics/apache

Ensure `mod_status` is enabled and configure a location block to expose the status page with `ExtendedStatus On` for detailed metrics.

```apache
<Location "/server-status">
    SetHandler server-status
    Require local
</Location>
ExtendedStatus On
```

--------------------------------

### NGINX Default Timestamp Format

Source: https://simpleobservability.com/docs/logs/nginx

The agent expects the default NGINX access log format, specifically parsing the standard timestamp for accurate event ordering. Ensure your log_format directive includes $time_local in this bracketed format.

```text
[02/Jan/2006:15:04:05 -0700]
```

--------------------------------

### Add Agent to Journal Group

Source: https://simpleobservability.com/docs/logs/journal

Manually add the 'simob-agent' user to the 'systemd-journal' group if it is missing. This command requires superuser privileges.

```bash
sudo usermod -aG systemd-journal simob-agent
```

--------------------------------

### Verify PHP-FPM Status Endpoint with cgi-fcgi

Source: https://simpleobservability.com/docs/metrics/phpfpm

Manually query the PHP-FPM status endpoint over FastCGI to verify its accessibility and response format. This helps in troubleshooting discovery issues.

```bash
SCRIPT_NAME=/status \
SCRIPT_FILENAME=/status \
REQUEST_METHOD=GET \
QUERY_STRING=json \
cgi-fcgi -bind -connect 127.0.0.1:9000

```

--------------------------------

### Verify Apache Status Endpoint

Source: https://simpleobservability.com/docs/metrics/apache

Use `curl` to test if Apache is correctly exposing statistics in the machine-readable format expected by the agent.

```bash
curl http://localhost/server-status?auto
```

--------------------------------

### Verify NGINX Log File Access

Source: https://simpleobservability.com/docs/logs/nginx

Manually check if the simob-agent user has read permissions for the NGINX access log file. This command helps troubleshoot issues where logs are not appearing in the dashboard due to access restrictions.

```bash
sudo -u simob-agent head -n 1 /var/log/nginx/access.log
```

--------------------------------

### Verify NGINX Status Endpoint

Source: https://simpleobservability.com/docs/metrics/nginx

Use `curl` to test if NGINX is correctly exposing statistics locally at the `/nginx_status` endpoint.

```bash
curl http://127.0.0.1/nginx_status
```

--------------------------------

### Verify Agent Group Membership

Source: https://simpleobservability.com/docs/logs/journal

Check if the 'simob-agent' user is part of the 'systemd-journal' group. This is necessary if journal logs are not appearing and system capabilities are disabled.

```bash
groups simob-agent
```

--------------------------------

### Remove simob systemd Service File

Source: https://simpleobservability.com/docs/installation

Removes the systemd service file for simob and reloads the systemd daemon. This is a necessary step for a complete uninstallation.

```bash
sudo rm /etc/systemd/system/simob.service
sudo systemctl daemon-reload
```

--------------------------------

### Stop and Delete simob Windows Service

Source: https://simpleobservability.com/docs/installation

Commands to stop and remove the simob Windows service. This is the first step in uninstalling the agent on Windows.

```powershell
Stop-Service -Name simob
sc.exe delete simob
```

--------------------------------

### Remove simob User and Group

Source: https://simpleobservability.com/docs/installation

Deletes the dedicated simob user and group from the system. This is performed after removing the agent's files and services.

```bash
sudo userdel simob-agent
sudo groupdel simob-admins
```
Tokens:
Raw