Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kinduff/csgo_exporter

A Prometheus exporter for Counter-Strike: Global Offensive.
https://github.com/kinduff/csgo_exporter

counter-strike-global-offensive csgo docker golang grafana grafana-dashboard hacktoberfest prometheus

Last synced: 11 days ago
JSON representation

A Prometheus exporter for Counter-Strike: Global Offensive.

Host: GitHub
URL: https://github.com/kinduff/csgo_exporter
Owner: kinduff
License: apache-2.0
Created: 2021-03-21T17:06:39.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2023-10-11T21:24:17.000Z (about 1 year ago)
Last Synced: 2024-10-15T16:40:48.738Z (19 days ago)
Topics: counter-strike-global-offensive, csgo, docker, golang, grafana, grafana-dashboard, hacktoberfest, prometheus
Language: Go
Homepage:
Size: 2.14 MB
Stars: 19
Watchers: 3
Forks: 3
Open Issues: 5
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        ![CSGO Exporter banner](extra/images/banner.png)

# CSGO Exporter

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/kinduff/csgo_exporter?)][releases]

[![Go Reference](https://pkg.go.dev/badge/github.com/kinduff/csgo_exporter.svg?)][godoc]

[![Go Report Card](https://goreportcard.com/badge/github.com/kinduff/csgo_exporter?)][goreport]

[![CodeFactor](https://www.codefactor.io/repository/github/kinduff/csgo_exporter/badge)][codefactor]

[![Test / Build](https://github.com/kinduff/csgo_exporter/actions/workflows/ci.yml/badge.svg?branch=master)][workflow-c]

[![Docker Pulls](https://img.shields.io/docker/pulls/kinduff/csgo_exporter.svg?)][dockerhub]

[![GitHub all releases](https://img.shields.io/github/downloads/kinduff/csgo_exporter/total?)][releases]

This is a Prometheus exporter for [Counter-Strike: Global Offensive][csgo]. It provides statistics from diverse categories, including last matches.

An example of the output of this exporter can be found [here][metrics_example].

## Grafana Dashboard

This wouldn't be an exporter without its corresponding Grafana Dashboard.

![Grafana Dashboard](extra/images/grafana.png)

This dashboard can be found with the ID `14629` using the Grafana import ([dashboard link][dashboard_link]) or [here in plain text][grafana_dashboard].

## Prerequisites

One of the two, depending on your running method.

* [Go][go] `>= 1.13`

* [Docker][docker]

## Running this exporter

See [Configuration][configuration] in order to set the necessary params to run the exporter.

### Using a binary

You can download the latest version of the binary built for your architecture [here][releases].

### Using Docker

The exporter is also available as a Docker image in [DockerHub][dockerhub] and [Github CR][ghcr]. You can run it using the following example and pass the configuration as environment variables:

```shell

$ docker run \

  --name csgo_exporter \

  -p 7355:7355 \

  -e STEAM_API_KEY= \

  -e STEAM_NAME= \

  -e STEAM_ID= \

  kinduff/csgo_exporter:latest

```

Alternative, you can use `ghcr.io/kinduff/csgo_exporter` if you want to use the Github Container Registry.

### Using the source

Optionally, you can download and build it from the sources. You have to retrieve the project sources by using one of the following way:

```shell

$ go get -u github.com/kinduff/csgo_exporter

# or

$ git clone https://github.com/kinduff/csgo_exporter.git

```

Install the needed vendors:

```shell

$ GO111MODULE=on go mod vendor

```

Then, build the binary:

```shell

$ go build -o csgo_exporter .

```

## Configuration

You can use both environment variables or parameters in both the binary or the docker image. If you wish to use parameters, simply invoke the same environment variable but in downcase, or use the flag `--help` for more information.

| Environment variable                   | Description                                                                                         | Default                         | Required |

| -------------------------------------- | --------------------------------------------------------------------------------------------------- | ------------------------------- | -------- |

| `HTTP_PORT`                            | The port the exporter will be running the HTTP server                                               | 7355^[1](#f1) |          |

| `SCRAPE_INTERVAL`                      | Time in natural format to scrap statistics from the CS:GO APIs                                      | `15m`                           |          |

| `STEAM_API_KEY`                        | Your personal API key from Steam, get one using [this link][steam-api]                              |                                 | Yes      |

| `STEAM_ID` ^[2](#f2) | The Steam ID you want to fetch the data from for the player statistics                              |                                 | Yes      |

| `STEAM_NAME`                           | If you don't want to provide a `STEAM_ID` you can provide your username, see the footnotes          |                                 |          |

| `FETCH_INVENTORY`                      | Boolean to determine if the exporter should fetch the player's inventory^[3](#f3) | `false`                         |          |

| `CURRENCY`                             | The price currency to display the average cost of the player inventory items                        | EUR                             |          |

## Available Prometheus metrics

| Metric name                  | Description                                                                                            |

| ---------------------------- | ------------------------------------------------------------------------------------------------------ |

| `csgo_stats_metric`          | All the stats from the player, it includes last_match data, totals per weapon, among other cool things |

| `csgo_total_kills_metric`    | Total kills from a player per weapon                                                                   |

| `csgo_total_shots_metric`    | Total shots from a player per weapon                                                                   |

| `csgo_total_hits_metric`     | Total hits from a player per weapon                                                                    |

| `csgo_achievements_metric`   | All achievements done by the player, with value `1` or `0` for achieved or not                         |

| `csgo_playtime_metric`       | Hours spent playing the game in minutes in different types, includes stats for each OS                 |

| `csgo_news_metric`           | The latest news from the CS: GO community, can be used in a table. Value is an epoch                   |

| `csgo_user_inventory_metric` | The player's inventory and the cost of each item. Value is the average cost in the desired currency.   |

## Contributors

Thanks goes to these wonderful people who had contributed to the project:

  

    

      
_{Simon Szustkowski}
🖋

      
_{Oleg Zaytsev}
🖋

      
_Jack
💻

    

  

## Footnotes

* [1]: This port is being assigned for fun, since the bomb code from Counter Strike is `7355608`.

* [2]: Please note that the `STEAM_ID` environment variable is not required if you provide a `STEAM_NAME`. If you want to save 1 HTTP call, provide both variables.

* [3]: Inventory should be public, if it's not, the request will fail and the program will exit.

[codefactor]: https://www.codefactor.io/repository/github/kinduff/csgo_exporter

[configuration]: #configuration

[csgo]: https://store.steampowered.com/app/730/CounterStrike_Global_Offensive

[docker]: https://docs.docker.com

[dockerhub]: https://hub.docker.com/r/kinduff/csgo_exporter

[ghcr]: #ghcr

[go]: https://golang.org

[godoc]: https://pkg.go.dev/github.com/kinduff/csgo_exporter

[goreport]: https://goreportcard.com/report/github.com/kinduff/csgo_exporter

[releases]: https://github.com/kinduff/csgo_exporter/releases

[steam-api]: https://steamcommunity.com/dev/apikey

[workflow-c]: https://github.com/kinduff/csgo_exporter/actions/workflows/ci.yml

[metrics_example]: extra/metrics_example.txt

[dashboard_link]: https://grafana.com/grafana/dashboards/14629

[grafana_dashboard]: extra/grafana_dashboard.json