Sha256: 2fe43bc95cf5063a316621cb6272ddaf73dbb76fee43a8b31817b1e22e1f6d93

Contents?: true

Size: 1.62 KB

Versions: 16

Compression:

Stored size: 1.62 KB

Contents

# Troubleshooting

The Instana gem has been designed to be fully automatic in process metric reporting and trace reporting.  But if something
goes wrong, you can use the following steps and tips to potentially diagnose any issues that may exist.

# Supported Components

Make sure that the component that you want to get visibility into has been added to the support matrix.  A list of all
supported components can be found in the [documentation](https://docs.instana.io/ecosystem/ruby/).

# Logging & Environment Variables

By default, the gem will log informational messages on boot that will indicate if any problems were encountered.  If you
set the `INSTANA_DEBUG` environment variable, it will increase the amount of logging output.

![instana console output](https://s3.amazonaws.com/instana/Instana+Ruby+boot+console+logging+output.png)

In the example above, you can see that the host agent isn't available.  Once the host agent is available, the Instana
gem will automatically re-connect without any intervention.

There are even more methods to control logging output.  See the [Configuration](https://github.com/instana/ruby-sensor/blob/master/Configuration.md#logging)
document for details.

# Testing in your Application

To diagnose the Instana gem from your application, often simply opening an application console with verbose logging can be
enough to identify any potential issues:

![rails console](https://s3.amazonaws.com/instana/Instana+Ruby+Rails+console+output.png)

In the example above, you can see the Instana Ruby gem initialize, instrument some components and a success notification: `Host agent available. We're
in business`.

Version data entries

16 entries across 16 versions & 1 rubygems

Version Path
instana-1.10.6-java Troubleshooting.md
instana-1.10.6 Troubleshooting.md
instana-1.10.6.fastrabbit Troubleshooting.md
instana-1.10.5-java Troubleshooting.md
instana-1.10.5 Troubleshooting.md
instana-1.10.4-java Troubleshooting.md
instana-1.10.4 Troubleshooting.md
instana-1.10.3-java Troubleshooting.md
instana-1.10.3 Troubleshooting.md
instana-1.10.2-java Troubleshooting.md
instana-1.10.2 Troubleshooting.md
instana-1.10.1-java Troubleshooting.md
instana-1.10.1 Troubleshooting.md
instana-1.10.0 Troubleshooting.md
instana-1.10.0.slimfast Troubleshooting.md
instana-1.9.7 Troubleshooting.md