Downloads:

64

Downloads of v 0.0.3:

33

Last Update:

23 Sep 2021

Package Maintainer(s):

Software Author(s):

  • Jacob Okamoto

Tags:

nvml-exporter prometheus nvml nvidia gpu monitoring

NVML Exporter

  • 1
  • 2
  • 3

0.0.3 | Updated: 23 Sep 2021

Downloads:

64

Downloads of v 0.0.3:

33

Maintainer(s):

Software Author(s):

  • Jacob Okamoto

  • 1
  • 2
  • 3
NVML Exporter 0.0.3

  • 1
  • 2
  • 3

Some Checks Are Exempted or Have Failed

Not All Tests Have Passed


Validation Testing Passed


Verification Testing Exemption:

Requires an Nvidia GPU Drivers

Details

Scan Testing Resulted in Flagged as a Note:

At least one file within this package has greater than 0 detections, but less than 5

Details

Deployment Method: Individual Install, Upgrade, & Uninstall

To install NVML Exporter, run the following command from the command line or from PowerShell:

>

To upgrade NVML Exporter, run the following command from the command line or from PowerShell:

>

To uninstall NVML Exporter, run the following command from the command line or from PowerShell:

>

Deployment Method:

📝 NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade nvml-exporter -y --source="'INTERNAL REPO URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade nvml-exporter -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install nvml-exporter
  win_chocolatey:
    name: nvml-exporter
    version: '0.0.3'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'nvml-exporter' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '0.0.3'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller nvml-exporter
{
    Name     = "nvml-exporter"
    Version  = "0.0.3"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'nvml-exporter':
  ensure   => '0.0.3',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved by moderator TheCakeIsNaOH on 24 Sep 2021.

Description

This package installs an NVML exporter for NVIDIA GPU metrics via the Prometheus metrics data format.

## Configuration

You can change the port used for listening (default=9996):

--params "'/ListenPort:12345'"

You can also enable collection of GPU throttling reasons (disabled by default):

--params "'/EnableThrottleReasons'"

ECC memory error collection is disabled unless ECC memory is available and currently in ECC mode. GeForce GPUs do not have ECC memory.


tools\chocolateybeforemodify.ps1
Stop-Service nvml-exporter
Write-Debug "stopped nvml-exporter service"
tools\chocolateyinstall.ps1
$ErrorActionPreference = 'Stop';
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"

$arguments = @{};
# /ListenPort: /EnableThrottleReasons
$packageParameters = $env:chocolateyPackageParameters;

# Default parameter values
## /EnableThrottleReasons
$enableThrottleReasons = $false
## /ListenPort:
$port = 9996

if ($packageParameters) {
    $match_pattern = "\/(?<option>([a-zA-Z]+)):(?<value>([`"'])?([a-zA-Z0-9- _\\:\.]+)([`"'])?)|\/(?<option>([a-zA-Z]+))"
    $option_name = 'option'
    $value_name = 'value'

    if ($packageParameters -match $match_pattern ){
        $results = $packageParameters | Select-String $match_pattern -AllMatches
        $results.matches | % {
          $arguments.Add(
              $_.Groups[$option_name].Value.Trim(),
              $_.Groups[$value_name].Value.Trim())
      }
    }
    else
    {
      throw "Package Parameters were found but were invalid (REGEX Failure)"
    }

    if ($arguments.ContainsKey("EnableThrottleReasons")) {
        Write-Host "Param: enable throttle reasons collections"
        $enableThrottleReasons = $true
    }
    if ($arguments.ContainsKey("ListenPort")) {
        $port = $arguments["ListenPort"]
        Write-Host "Param: use custom port $port"
    }
} else {
    Write-Debug "No Package Parameters Passed in";
}

$binPath = "$toolsDir\nvml_exporter_svc.exe"
# TODO(https://github.com/oko/nvml-exporter-rs/issues/2): allow listen address configuration
$binPath += " --listen 0.0.0.0:$port"
$binPath += " --listen [::]:$port"
if ($enableThrottleReasons) {
    $binPath += " --throttle-reasons"
}

try {
    # get service to check if this is an upgrade
    Get-Service -Name "nvml-exporter"
} catch {
    # create service if it doesn't exist
    New-Service -BinaryPathName $binPath -Name "nvml-exporter" -StartupType Automatic
}
Start-Service "nvml-exporter"
tools\chocolateyuninstall.ps1
$ErrorActionPreference = 'Stop'; # stop on all errors
Start-ChocolateyProcessAsAdmin -ExeToRun "sc.exe" -Statements "delete","nvml-exporter"
tools\LICENSE.txt
From: https://github.com/oko/nvml-exporter-rs/blob/main/LICENSE

LICENSE

Copyright 2021 Jacob Okamoto

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
tools\nvml_exporter_svc.exe
md5: 3256214EC092EC062396F8F1B3B56886 | sha1: B4AB52227A81E4A1322F03F3ED70964DCB25D10C | sha256: 65F92AFC8C674BA7EC6212582A1FAE8621677F52B549B19BC087C1B605DD86D4 | sha512: 89D3B3D2BCB4BD4BFD8F3F07D115CEC642EF552CCEFD226F95A9D4A2354A5C73BCFC992A9494E08DDE5B5A19343335A7CB98848DEC7F1CD8A3BF0F61531E2EE4
tools\VERIFICATION.txt
VERIFICATION
Verification is intended to assist the Chocolatey moderators and community
in verifying that this package's contents are trustworthy.
 
This package is owned by the software author, Jacob Okamoto (https://github.com/oko).
`nupkg` files are generated by GitHub actions and pushed to Choco for moderation upon creation
of a [new release](https://github.com/oko/nvml-exporter-rs/releases).

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Add to Builder Version Downloads Last Updated Status
NVML Exporter 0.0.2 28 Wednesday, September 22, 2021 Approved

This package has no dependencies.

Discussion for the NVML Exporter Package

Ground Rules:

  • This discussion is only about NVML Exporter and the NVML Exporter package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or NVML Exporter, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus