-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
当月の請求金額: sakuracloud_bill_amount (#99)
- Loading branch information
1 parent
8520954
commit f0450ad
Showing
7 changed files
with
289 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| // Copyright 2019-2022 The sakuracloud_exporter Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package collector | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/go-kit/kit/log" | ||
| "github.com/go-kit/kit/log/level" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| "github.com/sacloud/sakuracloud_exporter/platform" | ||
| ) | ||
|
|
||
| // BillCollector collects metrics about the account. | ||
| type BillCollector struct { | ||
| ctx context.Context | ||
| logger log.Logger | ||
| errors *prometheus.CounterVec | ||
| client platform.BillClient | ||
|
|
||
| Amount *prometheus.Desc | ||
| } | ||
|
|
||
| // NewBillCollector returns a new BillCollector. | ||
| func NewBillCollector(ctx context.Context, logger log.Logger, errors *prometheus.CounterVec, client platform.BillClient) *BillCollector { | ||
| errors.WithLabelValues("bill").Add(0) | ||
|
|
||
| labels := []string{"member_id"} | ||
|
|
||
| return &BillCollector{ | ||
| ctx: ctx, | ||
| logger: logger, | ||
| errors: errors, | ||
| client: client, | ||
|
|
||
| Amount: prometheus.NewDesc( | ||
| "sakuracloud_bill_amount", | ||
| "Amount billed for the month", | ||
| labels, nil, | ||
| ), | ||
| } | ||
| } | ||
|
|
||
| // Describe sends the super-set of all possible descriptors of metrics | ||
| // collected by this Collector. | ||
| func (c *BillCollector) Describe(ch chan<- *prometheus.Desc) { | ||
| ch <- c.Amount | ||
| } | ||
|
|
||
| // Collect is called by the Prometheus registry when collecting metrics. | ||
| func (c *BillCollector) Collect(ch chan<- prometheus.Metric) { | ||
| bill, err := c.client.Read(c.ctx) | ||
| if err != nil { | ||
| c.errors.WithLabelValues("bill").Add(1) | ||
| level.Warn(c.logger).Log( // nolint | ||
| "msg", "can't get bill", | ||
| "err", err, | ||
| ) | ||
| return | ||
| } | ||
|
|
||
| if bill != nil { | ||
| labels := []string{bill.MemberID} | ||
|
|
||
| // Amount | ||
| ch <- prometheus.MustNewConstMetric( | ||
| c.Amount, | ||
| prometheus.GaugeValue, | ||
| float64(bill.Amount), | ||
| labels..., | ||
| ) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| // Copyright 2019-2022 The sakuracloud_exporter Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package collector | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/prometheus/client_golang/prometheus" | ||
| "github.com/sacloud/iaas-api-go" | ||
| "github.com/sacloud/sakuracloud_exporter/platform" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| type dummyBillClient struct { | ||
| bill *iaas.Bill | ||
| err error | ||
| } | ||
|
|
||
| func (d *dummyBillClient) Read(ctx context.Context) (*iaas.Bill, error) { | ||
| return d.bill, d.err | ||
| } | ||
|
|
||
| func TestBillCollector_Describe(t *testing.T) { | ||
| initLoggerAndErrors() | ||
| c := NewBillCollector(context.Background(), testLogger, testErrors, &dummyBillClient{}) | ||
|
|
||
| descs := collectDescs(c) | ||
| require.Len(t, descs, len([]*prometheus.Desc{ | ||
| c.Amount, | ||
| })) | ||
| } | ||
|
|
||
| func TestBillCollector_Collect(t *testing.T) { | ||
| initLoggerAndErrors() | ||
| c := NewBillCollector(context.Background(), testLogger, testErrors, nil) | ||
|
|
||
| cases := []struct { | ||
| name string | ||
| in platform.BillClient | ||
| wantLogs []string | ||
| wantErrCounter float64 | ||
| wantMetrics []*collectedMetric | ||
| }{ | ||
| { | ||
| name: "collector returns error", | ||
| in: &dummyBillClient{ | ||
| err: errors.New("dummy"), | ||
| }, | ||
| wantLogs: []string{`level=warn msg="can't get bill" err=dummy`}, | ||
| wantErrCounter: 1, | ||
| wantMetrics: nil, | ||
| }, | ||
| { | ||
| name: "empty result", | ||
| in: &dummyBillClient{}, | ||
| wantMetrics: nil, | ||
| }, | ||
| { | ||
| name: "a bill", | ||
| in: &dummyBillClient{ | ||
| bill: &iaas.Bill{ | ||
| ID: 101, | ||
| Amount: 1234, | ||
| Date: time.Now(), | ||
| MemberID: "memberID", | ||
| Paid: false, | ||
| PayLimit: time.Now(), | ||
| PaymentClassID: 0, | ||
| }, | ||
| }, | ||
| wantMetrics: []*collectedMetric{ | ||
| { | ||
| // Discount | ||
| desc: c.Amount, | ||
| metric: createGaugeMetric(1234, map[string]string{ | ||
| "member_id": "memberID", | ||
| }), | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range cases { | ||
| initLoggerAndErrors() | ||
| c.logger = testLogger | ||
| c.errors = testErrors | ||
| c.client = tc.in | ||
|
|
||
| collected, err := collectMetrics(c, "bill") | ||
| require.NoError(t, err) | ||
| require.Equal(t, tc.wantLogs, collected.logged) | ||
| require.Equal(t, tc.wantErrCounter, *collected.errors.Counter.Value) | ||
| requireMetricsEqual(t, tc.wantMetrics, collected.collected) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| // Copyright 2019-2022 The sakuracloud_exporter Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package platform | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "sync" | ||
|
|
||
| "github.com/sacloud/iaas-api-go" | ||
| "github.com/sacloud/iaas-api-go/types" | ||
| ) | ||
|
|
||
| // BillClient calls SakuraCloud bill API | ||
| type BillClient interface { | ||
| Read(context.Context) (*iaas.Bill, error) | ||
| } | ||
|
|
||
| func getBillClient(caller iaas.APICaller) BillClient { | ||
| return &billClient{caller: caller} | ||
| } | ||
|
|
||
| type billClient struct { | ||
| caller iaas.APICaller | ||
| accountID types.ID | ||
| once sync.Once | ||
| } | ||
|
|
||
| func (c *billClient) Read(ctx context.Context) (*iaas.Bill, error) { | ||
| var err error | ||
| c.once.Do(func() { | ||
| var auth *iaas.AuthStatus | ||
|
|
||
| authStatusOp := iaas.NewAuthStatusOp(c.caller) | ||
| auth, err = authStatusOp.Read(ctx) | ||
| if err != nil { | ||
| return | ||
| } | ||
| if !auth.ExternalPermission.PermittedBill() { | ||
| err = fmt.Errorf("account doesn't have permissions to use the Billing API") | ||
| } | ||
| c.accountID = auth.AccountID | ||
| }) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if c.accountID.IsEmpty() { | ||
| return nil, errors.New("getting AccountID is failed. please check your API Key settings") | ||
| } | ||
|
|
||
| billOp := iaas.NewBillOp(c.caller) | ||
| searched, err := billOp.ByContract(ctx, c.accountID) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| var bill *iaas.Bill | ||
| for i := range searched.Bills { | ||
| b := searched.Bills[i] | ||
| if i == 0 || bill.Date.Before(b.Date) { | ||
| bill = b | ||
| } | ||
| } | ||
| return bill, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters