gbilling-plot

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #llm #go #rust #nodejs #cli #awesome-list #pytorch #mcp #open-source

(★ 10)

Create graphed invoice for Google Cloud Platform. You can see billing amount per GCP project.

gbilling-plot 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# gbilling-plot
![go version 1.12](https://img.shields.io/badge/go-v1.12-green.svg)
[![Apache 2.0 License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://raw.githubusercontent.com/future-architect/gbilling-plot/master/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/future-architect/gbilling-plot)](https://goreportcard.com/report/github.com/future-architect/gcp-instance-scheduler)

Create graphed invoice for Google Cloud Platform. You can see billing amount per GCP project.

## Usage

This package uses below great services.

- Google Cloud Billing（BigQuery）
- Google Cloud Functions
- Google Cloud Pub/Sub
- Google Cloud Scheduler
- Slack API

## QuickStart

1. Install
    ```console
    go get -u go get -u github.com/future-architect/gbilling-plot/cmd/gbplot
    ```
2. Obtain GCP Service credentials that must have `bigquery.tables.getData` and `bigquery.jobs.create` permission
  * You can assign predefined Cloud IAM roles that are `dataViewer` and `jobUser`
3. Set environment variable
    ```bash
    export GOOGLE_APPLICATION_CREDENTIALS=<credentials path>
    ```
4. Export your GCP billing to BigQuery
    * https://cloud.google.com/billing/docs/how-to/export-data-bigquery
5. Run command
    ```bash
    gbplot -project <your project name> -table <your billing table name on bigquery> -out out.png
    ```
6. You can confirm out.png file

## Options

```console
$ gbplot --help
  Usage of gbplot:
    -l int
          Max display project count (default 8)
    -limit int
          Max display project count (default 8)
    -o string
          Output file name (default "out.png")
    -out string
          Output file name (default "out.png")
    -p string
          GCP project name
    -project string
          GCP project name
    -t string
          BigQuery billing table name
    -table string
          BigQuery billing table name
```

## Deploy Google Cloud Function

### Requirements

* [Go](https://golang.org/dl/) more than 1.11
* [Cloud SDK](https://cloud.google.com/sdk/install/)

### Steps

1. [Get Slack API Token](https://get.slack.help/hc/en-us/articles/215770388-Create-and-regenerate-API-tokens#-internal-app-tokens)
    * Permission Scopes is required `files:write:user`
    * Create `Bot User OAuth Access Token` and `Install App`
2. [Create Slack Bot User](https://get.slack.help/hc/en-us/articles/215770388-Create-and-regenerate-API-tokens#-bot-user-tokens)
    * invite bot user to slack channel
3. [Export your GCP billing to BigQuery](https://cloud.google.com/billing/docs/how-to/export-data-bigquery)
4. Create Cloud Scheduler
    ```sh
    gcloud beta scheduler jobs create pubsub graph-billing --project "<your project name>" \
      --schedule "50 23 * * *" \
      --topic graph-billing \
      --message-body="{}" \
      --time-zone "Asia/Tokyo" \
      --description "This is scheduler for graph billing."
    ```
5. Deploy to Cloud Function
    ```sh
    git clone https://github.com/future-architect/gbilling-plot.git
    cd gbilling-plot
    gcloud functions deploy graphBilling --project "<your project name>" \
      --entry-point GraphedBilling \
      --triggerz-resource graph-billing \
      --trigger-event google.pubsub.topic.publish \
      --runtime go111 \
      --set-env-vars TABLE_NAME="<your billing table name on bigquery>" \
      --set-env-vars SLACK_API_TOKEN="<your slack api token>" \
      --set-env-vars SLACK_CHANNEL="<your slack channel name>"
    ```
6. Go to the [Cloud Scheduler page](https://cloud.google.com/scheduler/docs/tut-pub-sub) and click the *run now* button of *graphBilling*

## Example

Sample output is below.

![example](https://raw.githubusercontent.com/future-architect/gbilling-plot/master/img/example_grapth.png)

## License

This project is licensed under the Apache License 2.0 License - see the [LICENSE](LICENSE) file for details

gbilling-plot

gbilling-plot 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

gbilling-plot

gbilling-plot 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README