Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Juju 7288/add prom metric for jimm methods #1491

Merged
merged 3 commits into from
Dec 12, 2024
Merged

Juju 7288/add prom metric for jimm methods #1491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9855d3c
add prometheus metric for jimm
SimoneDutto Dec 10, 2024
9019fea
fly-by rename of jimm methods from previous pr
SimoneDutto Dec 11, 2024
c0ac307
remove wrong error count
SimoneDutto Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions internal/jimm/access.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"github.com/canonical/jimm/v3/internal/jimmjwx"
"github.com/canonical/jimm/v3/internal/openfga"
ofganames "github.com/canonical/jimm/v3/internal/openfga/names"
"github.com/canonical/jimm/v3/internal/servermon"
jimmnames "github.com/canonical/jimm/v3/pkg/names"
)

Expand Down Expand Up @@ -723,10 +724,13 @@ func (j *JIMM) parseAndValidateTag(ctx context.Context, key string) (*ofganames.
//
// This approach to cleaning up tuples is intended to be temporary while we implement
// a better approach to eventual consistency of JIMM's database objects and OpenFGA tuples.
func (j *JIMM) OpenFGACleanup(ctx context.Context) error {
func (j *JIMM) OpenFGACleanup(ctx context.Context) (err error) {
const op = errors.Op("jimm.CleanupDyingModels")
zapctx.Info(ctx, string(op))
durationObserver := servermon.DurationObserver(servermon.JimmMethodsDurationHistogram, string(op))
defer durationObserver()
var (
continuationToken string
err error
tuples []ofga.Tuple
)
for {
Expand Down
6 changes: 3 additions & 3 deletions internal/jimm/model.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -759,10 +759,10 @@ func (m *modelSummariesMap) addModelSummary(summary jujuparams.ModelSummaryResul
m.modelSummaries[summary.Result.UUID] = summary
}

// ModelSummaries returns the list of modelsummary the user has access to.
// ListModelSummaries returns the list of modelsummary the user has access to.
// It queries the controllers and then merge the info from the JIMM db.
func (j *JIMM) ModelSummaries(ctx context.Context, user *openfga.User, maskingControllerUUID string) (jujuparams.ModelSummaryResults, error) {
const op = errors.Op("jimm.ModelSummaries")
func (j *JIMM) ListModelSummaries(ctx context.Context, user *openfga.User, maskingControllerUUID string) (jujuparams.ModelSummaryResults, error) {
const op = errors.Op("jimm.ListModelSummaries")

modelSummariesSafeMap := modelSummariesMap{}
modelSummaryResults := []jujuparams.ModelSummaryResult{}
Expand Down
7 changes: 5 additions & 2 deletions internal/jimm/model_cleanup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,18 @@ import (

"github.com/canonical/jimm/v3/internal/dbmodel"
"github.com/canonical/jimm/v3/internal/errors"
"github.com/canonical/jimm/v3/internal/servermon"
)

// CleanupDyingModels loops over dying models, contacting the respective controller.
// And deleting the model from our database if the error is `NotFound` which means the model was successfully deleted.
func (j *JIMM) CleanupDyingModels(ctx context.Context) error {
func (j *JIMM) CleanupDyingModels(ctx context.Context) (err error) {
const op = errors.Op("jimm.CleanupDyingModels")
zapctx.Info(ctx, string(op))
durationObserver := servermon.DurationObserver(servermon.JimmMethodsDurationHistogram, string(op))
defer durationObserver()

err := j.DB().ForEachModel(ctx, func(m *dbmodel.Model) error {
err = j.DB().ForEachModel(ctx, func(m *dbmodel.Model) error {
if m.Life != state.Dying.String() {
return nil
}
Expand Down
2 changes: 1 addition & 1 deletion internal/jimm/model_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1972,7 +1972,7 @@ func TestModelSummaries(t *testing.T) {
},
},
}
summaries, err := j.ModelSummaries(ctx, alice, "")
summaries, err := j.ListModelSummaries(ctx, alice, "")
c.Check(err, qt.IsNil)
c.Check(summaries.Results, qt.HasLen, t.expectedSummariesSize)
c.Check(summaries.Results, qt.DeepEquals, t.expectedSummaries)
Expand Down
4 changes: 2 additions & 2 deletions internal/jujuapi/modelmanager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ type ModelManager interface {
ImportModel(ctx context.Context, user *openfga.User, controllerName string, modelTag names.ModelTag, newOwner string) error
ModelDefaultsForCloud(ctx context.Context, user *dbmodel.Identity, cloudTag names.CloudTag) (jujuparams.ModelDefaultsResult, error)
ModelInfo(ctx context.Context, u *openfga.User, mt names.ModelTag) (*jujuparams.ModelInfo, error)
ModelSummaries(ctx context.Context, user *openfga.User, maskingControllerUUID string) (jujuparams.ModelSummaryResults, error)
ListModelSummaries(ctx context.Context, user *openfga.User, maskingControllerUUID string) (jujuparams.ModelSummaryResults, error)
ModelStatus(ctx context.Context, u *openfga.User, mt names.ModelTag) (*jujuparams.ModelStatus, error)
QueryModelsJq(ctx context.Context, models []string, jqQuery string) (params.CrossModelQueryResponse, error)
SetModelDefaults(ctx context.Context, user *dbmodel.Identity, cloudTag names.CloudTag, region string, configs map[string]interface{}) error
Expand Down Expand Up @@ -113,7 +113,7 @@ func (r *controllerRoot) ListModelSummaries(ctx context.Context, _ jujuparams.Mo
if r.controllerUUIDMasking {
maskingControllerUUID = r.params.ControllerUUID
}
res, err := r.jimm.ModelSummaries(ctx, r.user, maskingControllerUUID)
res, err := r.jimm.ListModelSummaries(ctx, r.user, maskingControllerUUID)
if err != nil {
return jujuparams.ModelSummaryResults{}, errors.E(op, err)
}
Expand Down
13 changes: 7 additions & 6 deletions internal/servermon/monitoring.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ var (
Help: "Histogram of database query time in seconds",
Buckets: []float64{.005, .01, .025, .05, .1, .25, .5, 1, 2.5, 5, 10},
}, []string{"method"})
JimmMethodsDurationHistogram = promauto.NewHistogramVec(prometheus.HistogramOpts{
Namespace: "jimm",
Subsystem: "jimm",
Name: "op_duration_seconds",
Help: "Histogram of jimm operations time in seconds",
Buckets: []float64{.005, .01, .025, .05, .1, .25, .5, 1, 2.5, 5, 10},
}, []string{"method"})
DBQueryErrorCount = promauto.NewCounterVec(prometheus.CounterOpts{
Namespace: "jimm",
Subsystem: "db",
Expand Down Expand Up @@ -101,12 +108,6 @@ var (
Name: "models_created_fail_total",
Help: "The number of fails attempting to create models.",
})
MonitorDeltasReceivedCount = promauto.NewCounterVec(prometheus.CounterOpts{
Namespace: "jimm",
Subsystem: "monitor",
Name: "deltas_received_total",
Help: "The number of watcher deltas received.",
}, []string{"controller"})
MonitorErrorsCount = promauto.NewCounterVec(prometheus.CounterOpts{
Namespace: "jimm",
Subsystem: "monitor",
Expand Down
8 changes: 4 additions & 4 deletions internal/testutils/jimmtest/mocks/model.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ type ModelManager struct {
ForEachModel_ func(ctx context.Context, u *openfga.User, f func(*dbmodel.Model, jujuparams.UserAccessPermission) error) error
ForEachUserModel_ func(ctx context.Context, u *openfga.User, f func(*dbmodel.Model, jujuparams.UserAccessPermission) error) error
FullModelStatus_ func(ctx context.Context, user *openfga.User, modelTag names.ModelTag, patterns []string) (*jujuparams.FullStatus, error)
ModelSummaries_ func(ctx context.Context, user *openfga.User, maskingControllerUUID string) (jujuparams.ModelSummaryResults, error)
ListModelSummaries_ func(ctx context.Context, user *openfga.User, maskingControllerUUID string) (jujuparams.ModelSummaryResults, error)
GetModel_ func(ctx context.Context, uuid string) (dbmodel.Model, error)
ImportModel_ func(ctx context.Context, user *openfga.User, controllerName string, modelTag names.ModelTag, newOwner string) error
IdentityModelDefaults_ func(ctx context.Context, user *dbmodel.Identity) (map[string]interface{}, error)
Expand Down Expand Up @@ -129,11 +129,11 @@ func (j *ModelManager) ModelStatus(ctx context.Context, u *openfga.User, mt name
return j.ModelStatus_(ctx, u, mt)
}

func (j *ModelManager) ModelSummaries(ctx context.Context, u *openfga.User, maskingControllerUUID string) (jujuparams.ModelSummaryResults, error) {
if j.ModelSummaries_ == nil {
func (j *ModelManager) ListModelSummaries(ctx context.Context, u *openfga.User, maskingControllerUUID string) (jujuparams.ModelSummaryResults, error) {
if j.ListModelSummaries_ == nil {
return jujuparams.ModelSummaryResults{}, errors.E(errors.CodeNotImplemented)
}
return j.ModelSummaries_(ctx, u, maskingControllerUUID)
return j.ListModelSummaries_(ctx, u, maskingControllerUUID)
}

func (j *ModelManager) QueryModelsJq(ctx context.Context, models []string, jqQuery string) (params.CrossModelQueryResponse, error) {
Expand Down
Loading