https://github.com/naseemkullah/gcp-accountant

A tool to identify high cost resources in GCP at a granular level
https://github.com/naseemkullah/gcp-accountant

bigquery cost cost-engineering cost-resources gcp gcp-accountant

Last synced: 2 months ago
JSON representation

A tool to identify high cost resources in GCP at a granular level

• Host: GitHub
• URL: https://github.com/naseemkullah/gcp-accountant
• Owner: naseemkullah
• Created: 2019-07-11T15:32:10.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T22:41:00.000Z (4 months ago)
• Last Synced: 2024-06-20T11:36:13.915Z (4 months ago)
• Topics: bigquery, cost, cost-engineering, cost-resources, gcp, gcp-accountant
• Language: TypeScript
• Size: 501 KB
• Stars: 15
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gcp-accountant

           /:""|

          |:`66|_

          C`    _)

           \ ._|

            ) /

           /`\\

          || |Y|

          || |#|

          || |#|

          || |#|

          :| |=:

          ||_|,|

          \)))||

       |~~~`-`~~~|

       |         |

       |_________|

       |_________|

           | ||

           |_||__

      jgs  (____))

A tool to identify high-cost resources in GCP at a granular level

## Prerequisites

* You must have [Billing export for BigQuery](https://cloud.google.com/billing/docs/how-to/export-data-bigquery) enabled

* You must be authorized to create BigQuery jobs

* It is highly recommended that resources be labeled at a granular level. The granularity of the labels will be reflected in the results.

## Installation

    npm install -g

## Usage

Execute `gcp-accountant` and answer the questions:

    $ gcp-accountant

    ? What is the billing dataset called? (Use arrow keys)

    ❯ billing

      not-billing

      not-billing-either

    [..]

## How it works

First, `gcp-accountant` makes use of [inquirer](https://www.npmjs.com/package/inquirer) and the [Google BigQuery Client Library for Node.js](https://www.npmjs.com/package/@google-cloud/bigquery) to gather some info from the user:

1. The name of the billing dataset

2. The name of the billing table

3. The invoice month to perform cost analysis on in `YYYYMM` format

Then `gcp-accountant` runs queries on the data by means of the aforementioned BigQuery client and the results are then displayed in the terminal by means of [cliui](https://www.npmjs.com/package/cliui) and [chalk](https://www.npmjs.com/package/chalk).

## THIS IS NOT AN OFFICIAL GOOGLE PRODUCT