Skip to content
This repository has been archived by the owner on Oct 2, 2022. It is now read-only.

SSH integration for metrics collection for ContainerSSH

License

Notifications You must be signed in to change notification settings

ContainerSSH/metricsintegration

ContainerSSH - Launch Containers on Demand

ContainerSSH Metrics Integration Library

⚠⚠⚠ Deprecated: ⚠⚠⚠
This repository is deprecated in favor of libcontainerssh for ContainerSSH 0.5.

This library integrates the metrics service with the sshserver library.

Using this library

This library is intended as an overlay/proxy for a handler for the sshserver library "handler". It can be injected transparently to collect the following metrics:

  • containerssh_ssh_connections
  • containerssh_ssh_handshake_successful
  • containerssh_ssh_handshake_failed
  • containerssh_ssh_current_connections
  • containerssh_auth_server_failures
  • containerssh_auth_failures
  • containerssh_auth_success

The handler can be instantiated with the following method:

handler, err := metricsintegration.New(
    config,
    metricsCollector,
    backend,
)
  • config is a configuration structure from the metrics library. This is used to bypass the metrics integration backend if metrics are disabled.
  • metricsCollector is the metrics collector from the metrics library.
  • backend is an SSH server backend from the sserver library.