Skip to main content

Monitoring using SNMP

GitHub Enterprise provides data on disk usage, CPU utilization, memory usage, and more over SNMP.

SNMP is a common standard for monitoring devices over a network. We strongly recommend enabling SNMP so you can monitor the health of your GitHub Enterprise Server instance and know when to add more memory, storage, or processor power to the host machine.

GitHub Enterprise has a standard SNMP installation, so you can take advantage of the many plugins available for Nagios or for any other monitoring system.

Configuring SNMP v2c

  1. GitHub Enterprise Server の管理アカウントから、任意のページの右上隅の をクリックします。

    サイト管理者設定にアクセスするための宇宙船アイコンのスクリーンショット

  2. [サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。

    [サイト管理者] リンクのスクリーンショット

  3. 左側のサイドバーで、 [Management Console] をクリックします。 左側のサイドバーの [[Management Console]] タブ

  4. 左側のサイドバーで、 [監視] をクリックします。 [監視] タブ

  5. [監視] で、 [Enable SNMP](SNMP を有効にする) を選びます。 SNMP を有効にするボタン

  6. In the Community string field, enter a new community string. If left blank, this defaults to public. Field to add the community string

  7. 左側のサイドバーで、 [設定の保存] をクリックします。

    [Management Console] の [設定の保存] ボタンのスクリーンショット

    注: [Management Console] に設定を保存すると、システム サービスが再起動され、ユーザーに表示されるダウンタイムが発生する可能性があります。

  8. 設定の実行が完了するのを待ってください。

    インスタンスの設定

  9. Test your SNMP configuration by running the following command on a separate workstation with SNMP support in your network:

    # community-string is your community string
    # hostname is the IP or domain of your Enterprise instance
    $ snmpget -v 2c -c COMMUNITY-STRING -O e HOSTNAME hrSystemDate.0

This should return the system time on your GitHub Enterprise Server instance host.

User-based security

If you enable SNMP v3, you can take advantage of increased user based security through the User Security Model (USM). For each unique user, you can specify a security level:

  • noAuthNoPriv: This security level provides no authentication and no privacy.
  • authNoPriv: This security level provides authentication but no privacy. To query the appliance you'll need a username and password (that must be at least eight characters long). Information is sent without encryption, similar to SNMPv2. The authentication protocol can be either MD5 or SHA and defaults to SHA.
  • authPriv: This security level provides authentication with privacy. Authentication, including a minimum eight-character authentication password, is required and responses are encrypted. A privacy password is not required, but if provided it must be at least eight characters long. If a privacy password isn't provided, the authentication password is used. The privacy protocol can be either DES or AES and defaults to AES.

Configuring users for SNMP v3

  1. GitHub Enterprise Server の管理アカウントから、任意のページの右上隅の をクリックします。

    サイト管理者設定にアクセスするための宇宙船アイコンのスクリーンショット

  2. [サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。

    [サイト管理者] リンクのスクリーンショット

  3. 左側のサイドバーで、 [Management Console] をクリックします。 左側のサイドバーの [[Management Console]] タブ

  4. 左側のサイドバーで、 [監視] をクリックします。 [監視] タブ

  5. [監視] で、 [Enable SNMP](SNMP を有効にする) を選びます。 SNMP を有効にするボタン

  6. Select SNMP v3. Button to enable SNMP v3

  7. In "Username", type the unique username of your SNMP v3 user. Field to type the SNMP v3 username

  8. In the Security Level dropdown menu, click the security level for your SNMP v3 user. Dropdown menu for the SNMP v3 user's security level

  9. For SNMP v3 users with the authnopriv security level: Settings for the authnopriv security level

    • "Authentication password"(認証パスワード)に、認証パスワードを入力してください。
    • [認証パスワード] の右の [プロトコル] ドロップダウン メニューから、使用する認証プロトコルをクリックします。
  10. For SNMP v3 users with the authpriv security level: Settings for the authpriv security level

    • "Authentication password"(認証パスワード)に、認証パスワードを入力してください。
    • [認証パスワード] の右の [プロトコル] ドロップダウン メニューから、使用する認証プロトコルをクリックします。
    • Optionally, in "Privacy password", type the privacy password.
    • On the right side of "Privacy password", in the Protocol dropdown menu, click the privacy protocol method you want to use.
  11. Click Add user. Button to add SNMP v3 user

  12. 左側のサイドバーで、 [設定の保存] をクリックします。

    [Management Console] の [設定の保存] ボタンのスクリーンショット

    注: [Management Console] に設定を保存すると、システム サービスが再起動され、ユーザーに表示されるダウンタイムが発生する可能性があります。

  13. 設定の実行が完了するのを待ってください。

    インスタンスの設定

Querying SNMP data

Both hardware and software-level information about your appliance is available with SNMP v3. Due to the lack of encryption and privacy for the noAuthNoPriv and authNoPriv security levels, we exclude the hrSWRun table (1.3.6.1.2.1.25.4) from the resulting SNMP reports. We include this table if you're using the authPriv security level. For more information, see the "OID reference documentation."

With SNMP v2c, only hardware-level information about your appliance is available. The applications and services within GitHub Enterprise do not have OIDs configured to report metrics. Several MIBs are available, which you can see by running snmpwalk on a separate workstation with SNMP support in your network:

# community-string is your community string
# hostname is the IP or domain of your Enterprise instance
$ snmpwalk -v 2c -c COMMUNITY-STRING -O e HOSTNAME

Of the available MIBs for SNMP, the most useful is HOST-RESOURCES-MIB (1.3.6.1.2.1.25). See the table below for some important objects in this MIB:

NameOIDDescription
hrSystemDate.21.3.6.1.2.1.25.1.2The hosts notion of the local date and time of day.
hrSystemUptime.01.3.6.1.2.1.25.1.1.0How long it's been since the host was last initialized.
hrMemorySize.01.3.6.1.2.1.25.2.2.0The amount of RAM on the host.
hrSystemProcesses.01.3.6.1.2.1.25.1.6.0The number of process contexts currently loaded or running on the host.
hrStorageUsed.11.3.6.1.2.1.25.2.3.1.6.1The amount of storage space consumed on the host, in hrStorageAllocationUnits.
hrStorageAllocationUnits.11.3.6.1.2.1.25.2.3.1.4.1The size, in bytes, of an hrStorageAllocationUnit

For example, to query for hrMemorySize with SNMP v3, run the following command on a separate workstation with SNMP support in your network:

# username is the unique username of your SNMP v3 user
# auth password is the authentication password
# privacy password is the privacy password
# hostname is the IP or domain of your Enterprise instance
$ snmpget -v 3 -u USERNAME -l authPriv \
  -A "AUTH PASSWORD" -a SHA \
  -X "PRIVACY PASSWORD" -x AES \
  -O e HOSTNAME HOST-RESOURCES-MIB::hrMemorySize.0

With SNMP v2c, to query for hrMemorySize, run the following command on a separate workstation with SNMP support in your network:

# community-string is your community string
# hostname is the IP or domain of your Enterprise instance
snmpget -v 2c -c COMMUNITY-STRING HOSTNAME HOST-RESOURCES-MIB::hrMemorySize.0

Note: To prevent leaking information about services running on your appliance, we exclude the hrSWRun table (1.3.6.1.2.1.25.4) from the resulting SNMP reports unless you're using the authPriv security level with SNMP v3. If you're using the authPriv security level, we include the hrSWRun table.

For more information on OID mappings for common system attributes in SNMP, see "Linux SNMP OID’s for CPU, Memory and Disk Statistics".