system-introspector --storage <path> [OPTIONS]
+=head1 DESCRIPTION
+
+See L<System::Introspector/DESCRIPTION> for more details.
+
=head1 OPTIONS
=head2 -s <path>, --storage <path>
Display help.
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
=cut
on the remote system that gather specific information. Gathered results
are stored in JSON format.
-=head1 CONTRIBUTORS
+=head1 AUTHOR
-phaylon - Robert Sedlacek (cpan:PHAYLON) <rs@474.at>
+ phaylon - Robert Sedlacek (cpan:PHAYLON) <rs@474.at>
-=head1 AUTHOR
+=head1 CONTRIBUTORS
-mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
+ mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
-=head1 SPONSORED
+=head1 SPONSORS
Lots of this stuff sponsored by L<http://socialflow.com>.
=head1 COPYRIGHT
-Copyright (c) 2012 the System::Introspector L</AUTHOR> and L</CONTRIBUTORS>
-as listed above.
+Copyright (c) 2012 the System::Introspector L</AUTHOR>, L</CONTRIBUTORS>
+and L</SPONSORS> as listed above.
=head1 LICENSE
This library is free software and may be distributed under the same terms
as perl itself.
+
+=cut
}
1;
+
+=head1 NAME
+
+System::Introspector::Config - Configuration file access
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
}
1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Gatherer - Remote Gather Handler
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
sub gather { (shift)->remote->gather(@_) }
1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Gatherer::Bridge - Bridged Connections
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::DiskUsage - Gather disk space usage data
+System::Introspector::Probe::DiskUsage - Gather disk space usage data
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::FileHandles - Gather opened filehandles
+System::Introspector::Probe::FileHandles - Gather opened filehandles
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::Groups - Gather group information
+System::Introspector::Probe::Groups - Gather group information
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::Host - Gather generic host information
+System::Introspector::Probe::Host - Gather generic host information
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::Hosts - Gather known hosts
+System::Introspector::Probe::Hosts - Gather known hosts
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::LibDirs::Perl - Gather perl lib directory data
+System::Introspector::Probe::LibDirs::Perl - Gather perl lib directory data
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::MountPoints - Gather moint point information
+System::Introspector::Probe::MountPoints - Gather moint point information
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::Nagios::CheckMkAgent - Gather check_mk_agent output
+System::Introspector::Probe::Nagios::CheckMkAgent - Gather check_mk_agent output
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::Packages::Apt - Gather APT package status
+System::Introspector::Probe::Packages::Apt - Gather APT package status
=head1 DESCRIPTION
=back
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
=cut
}
1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Probe::Perls - Locate perl installations
+
+=head1 DESCRIPTION
+
+Tries to locate perl installations on the system and collects
+information about them.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::Processes - Gather running processes
+System::Introspector::Probe::Processes - Gather running processes
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::Puppet - Gather puppet agent information
+System::Introspector::Probe::Puppet - Gather puppet agent information
=head1 DESCRIPTION
=back
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
=cut
=head1 NAME
-System::Introspector::Repositories::Git - Gather Git repository info
+System::Introspector::Probe::Repositories::Git - Gather Git repository info
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::ResolvConf - Gather name resolution configuration
+System::Introspector::Probe::ResolvConf - Gather name resolution configuration
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::Sudoers - Gather sudoer information
+System::Introspector::Probe::Sudoers - Gather sudoer information
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 NAME
-System::Introspector::Users - Gather user information
+System::Introspector::Probe::Users - Gather user information
=head1 DESCRIPTION
=back
-=cut
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
=head1 SYNOPSIS
my $state = System::Introspector::State->new(
- host => 'foo.example.com',
- storage => $storage_obj,
- config => {
- introspect => [qw( ProbeName )],
- },
+ root => '/root/path',
+ config => $config_object,
);
- my $data = $state->fetch;
- $state->fetch_and_store;
+ $state->gather;
=head1 DESCRIPTION
=head2 config
-A hash reference containing a C<introspect> key with an array reference
-value containing a list of probe names without the
-C<System::Introspector::Probe::> prefix. This attribute is required.
+A L<System::Introspector::Config>
-=head2 host
+=head2 root
-An optional hostname. If no hostname is supplied, the local configuration
-data will be fetched.
+Path to the storage root.
-=head2 storage
+=head1 METHODS
-A L<File::Tree::Snapshot> object.
+=head2 gather
-=head1 METHODS
+ $state->gather;
+
+Fetches all probe data and stores it in the tree below the L</root>.
+
+=head1 SEE ALSO
+
+=over
-=head2 fetch
+=item L<System::Introspector>
- my $data = $state->fetch;
+=back
-Fetches all probe data.
+=head1 COPYRIGHT
-=head2 fetch_and_store
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
- $state->fetch_and_store;
+=head1 LICENSE
-Fetches all probe data and stores it in the L</storage>.
+This library is free software and may be distributed under the same terms
+as perl itself.
=cut
}
1;
+
+__END__
+
+=head1 NAME
+
+System::Introspector::Util - Utility functions
+
+=head1 DESCRIPTION
+
+Contains utility functions for L<System::Introspector>.
+
+=head1 SEE ALSO
+
+=over
+
+=item L<System::Introspector>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the L<System::Introspector>
+L<AUTHOR|System::Introspector/AUTHOR>,
+L<CONTRIBUTORS|System::Introspector/CONTRIBUTORS> and
+L<SPONSORS|System::Introspector/SPONSORS>.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
projects / scpubgit/System-Introspector.git / commitdiff