135/netdisco
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

new Troubleshooting documentation

Browse Source
This commit is contained in:
Oliver Gorwits
2015-02-05 14:19:02 +00:00
parent 2e82ab2760
commit 24eeb42663
7 changed files with 89 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Netdisco/lib/App/Netdisco/Manual/Deployment.pod
View File

@@ -152,18 +152,6 @@ You are instead recommended to run C<netdisco-web> behind a reverse proxy as
described elsewhere in this document. Apache can easily act as an SSL reverse
proxy.
=head1 Debug Tricks
You can see what HTTP Headers are received by Netdisco, and other information
such as how it's parsing the config file, by enabling the Dancer debug plugin.
First download the plugin:
~/bin/localenv cpanm --notest Dancer::Debug
Then run the web daemon with the environment variable to enable the feature:
DANCER_DEBUG=1 ~/bin/netdisco-web restart
=head1 Database Backups
We recommend you backup the Netdisco database regularly. You could put the
@@ -177,13 +165,6 @@ following commands into a shell script and call it nightly from C<cron>:
This will keep 30 days of backups. You don't need to stop Netdisco during the
backup.
=head1 Database Schema Redeployment
The database schema can be fully redeployed (even over an existing
installation, in a safe way) using the following command:
~netdisco/bin/netdisco-db-deploy --reset
=head1 Further Reading...
Other ways to run and host the web application can be found in the

2
Netdisco/lib/App/Netdisco/Manual/ReleaseNotes.pod
View File

@@ -52,7 +52,7 @@ upgrade:
The database schema can be fully redeployed (even over an existing
installation, in a safe way) using the following command:
~netdisco/bin/netdisco-db-deploy --reset
~netdisco/bin/netdisco-db-deploy --redeploy-all
=head1 2.031002

65
Netdisco/lib/App/Netdisco/Manual/Troubleshooting.pod Normal file
View File

@@ -0,0 +1,65 @@
=head1 NAME
App::Netdisco::Manual::Troubleshooting - Tips and Tricks for Troubleshooting
=head1 Run a Polling Job with Debugging
The C<netdisco-do> command has several debug flags which will show what's
going on internally. Usually you always add C<-D> for general Netdisco
debugging, then C<-I> for L<SNMP::Info> logging and C<Q> for SQL tracing. For
example:
~netdisco/bin/netdisco-do discover -d 192.0.2.1 -DIQ
You will see that SNMPv2 community strings are hidden by default, to make the
output safe for sending to Netdisco developers. To show the community string,
set the C<SHOW_COMMUNITY> envinronment variable:
SHOW_COMMUNITY=1 ~netdisco/bin/netdisco-do discover -d 192.0.2.1 -DIQ
=head1 Dump an SNMP object for a Device
This is useful when trying to work out why some information isn't displaying
correctly (or at all) in Netdisco. It may be that the SNMP response isn't
understood. Netdisco can dump any leaf or table, by name:
~netdisco/bin/netdisco-do show -d 192.0.2.1 -e interfaces
~netdisco/bin/netdisco-do show -d 192.0.2.1 -e Layer2::HP::interfaces
=head1 Interactive SQL terminal on the Netdisco Database
Start an interactive terminal with the Netdisco PostgreSQL database. If you
pass an SQL statement in the "-e" option then it will be executed.
~netdisco/bin/netdisco-do psql
~netdisco/bin/netdisco-do psql -e 'SELECT ip, dns FROM device'
~netdisco/bin/netdisco-do psql -e 'COPY (SELECT ip, dns FROM device) TO STDOUT WITH CSV HEADER'
The last example above is useful for sending data to Netdisco developers, as
it's more compact and readable than the standard tabular output (second
example).
=head1 Database Schema Redeployment
The database schema can be fully redeployed (even over an existing
installation), in a safe way, using the following command:
~netdisco/bin/netdisco-db-deploy --redeploy-all
=head1 Debug HTTP Requests and Configuration
You can see HTTP Headers received by Netdisco, and other information such as
how it's parsing the config file, by enabling the Dancer debug plugin. First
download the plugin:
~netdisco/bin/localenv cpanm --notest Dancer::Debug
Then run the web daemon with the environment variable to enable the feature:
DANCER_DEBUG=1 ~/bin/netdisco-web restart
A side panel appears in the web page with debug information. Be sure to turn
this off when you're done (stop and start without the environment variable)
otherwise secrets could be leaked to end users.
=cut