diff --git a/README.md b/README.md index ae7c132..42fa8dd 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,28 @@ It opens the door for categorizing metrics by labels and sub-labels into sets, a that specification, giving us more flexibility when working with dynamic label sets where only higher order labels may be known (or matter). +### Installation + +Install the go package + +```go +go get github.com/sourcehawk/go-prometheus-gaugevecset +``` + +Importing it: + +```go +import ( + gvs "github.com/sourcehawk/go-prometheus-gaugevecset/pkg/gauge-vec-set" +) +``` + ### Initialization ```go import ( "github.com/prometheus/client_golang/prometheus" - gvs "github.com/sourcehawk/go-prometheus-gaugevecset/pkg/gauge_vec_set" + gvs "github.com/sourcehawk/go-prometheus-gaugevecset/pkg/gauge-vec-set" ) // Metric configuration diff --git a/go.mod b/go.mod index 309a41c..7a5bd87 100644 --- a/go.mod +++ b/go.mod @@ -4,7 +4,6 @@ go 1.25 require ( github.com/prometheus/client_golang v1.23.2 - github.com/prometheus/common v0.66.1 github.com/stretchr/testify v1.11.1 ) @@ -17,6 +16,7 @@ require ( github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect github.com/prometheus/client_model v0.6.2 // indirect + github.com/prometheus/common v0.66.1 // indirect github.com/prometheus/procfs v0.16.1 // indirect github.com/rogpeppe/go-internal v1.13.1 // indirect go.yaml.in/yaml/v2 v2.4.2 // indirect diff --git a/pkg/gauge_vec_set/gauge_vec_set.go b/pkg/gauge-vec-set/gauge_vec_set.go similarity index 100% rename from pkg/gauge_vec_set/gauge_vec_set.go rename to pkg/gauge-vec-set/gauge_vec_set.go diff --git a/pkg/gauge_vec_set/gauge_vec_set_benchmark_test.go b/pkg/gauge-vec-set/gauge_vec_set_benchmark_test.go similarity index 100% rename from pkg/gauge_vec_set/gauge_vec_set_benchmark_test.go rename to pkg/gauge-vec-set/gauge_vec_set_benchmark_test.go diff --git a/pkg/gauge_vec_set/gauge_vec_set_test.go b/pkg/gauge-vec-set/gauge_vec_set_test.go similarity index 100% rename from pkg/gauge_vec_set/gauge_vec_set_test.go rename to pkg/gauge-vec-set/gauge_vec_set_test.go