Class: Appsignal::CLI::Diagnose

Inherits:
Object
  • Object
show all
Extended by:
Data, Helpers
Defined in:
lib/appsignal/cli/diagnose.rb,
lib/appsignal/cli/diagnose/paths.rb,
lib/appsignal/cli/diagnose/utils.rb

Overview

Command line tool to run diagnostics on your project.

This command line tool is useful when testing AppSignal on a system and validating the local configuration. It outputs useful information to debug issues and it checks if AppSignal agent is able to run on the machine’s architecture and communicate with the AppSignal servers.

This diagnostic tool outputs the following:

  • if AppSignal can run on the host system.

  • if the configuration is valid and active.

  • if the Push API key is present and valid (internet connection required).

  • if the required system paths exist and are writable.

  • outputs AppSignal version information.

  • outputs information about the host system and Ruby.

  • outputs last lines from the available log files.

## Exit codes

  • Exits with status code ‘0` if the diagnose command has finished.

  • Exits with status code ‘1` if the diagnose command failed to finished.

Examples:

On the command line in your project

appsignal diagnose

With a specific environment

appsignal diagnose --environment=production

Automatically send the diagnose report without prompting

appsignal diagnose --send-report

Don’t prompt about sending the report and don’t sent it

appsignal diagnose --no-send-report

See Also:

Since:

  • 1.1.0

Defined Under Namespace

Modules: Data Classes: Paths, Utils

Constant Summary collapse

DIAGNOSE_ENDPOINT =

Since:

  • 1.1.0

"https://appsignal.com/diag"

Method Summary

Methods included from Data

current_section, data, data_section, save