fix(metrics): add missing stat metric scopes #3416

albertorm95 · 2023-05-19T09:42:15Z

what

Add project and commandName SubScope to CommandRunner scope.
Metrics:
- atlantis_cmd_comment_%COMMAND_project_execution_success -> atlantis_project_%COMMAND_execution_success

why

With only atlantis_project_execution_success metric there was no way of knowing if it was a plan, apply, etc.

tests

atlantis_cmd_comment_%COMMAND_project_execution_success - > atlantis_project_%COMMAND_execution_success

# HELP atlantis_cmd_comment_plan_execution_time atlantis_cmd_comment_plan_execution_time summary
# TYPE atlantis_cmd_comment_plan_execution_time summary
atlantis_cmd_comment_plan_execution_time{quantile="0.5"} 4.06519725
atlantis_cmd_comment_plan_execution_time{quantile="0.75"} 4.06519725
atlantis_cmd_comment_plan_execution_time{quantile="0.95"} 4.06519725
atlantis_cmd_comment_plan_execution_time{quantile="0.99"} 4.06519725
atlantis_cmd_comment_plan_execution_time{quantile="0.999"} 4.06519725
atlantis_cmd_comment_plan_execution_time_sum 4.06519725
atlantis_cmd_comment_plan_execution_time_count 1

# HELP atlantis_project_apply_execution_error atlantis_project_apply_execution_error counter
# TYPE atlantis_project_apply_execution_error counter
atlantis_project_apply_execution_error{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default"} 0

# HELP atlantis_project_apply_execution_failure atlantis_project_apply_execution_failure counter
# TYPE atlantis_project_apply_execution_failure counter
atlantis_project_apply_execution_failure{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default"} 0

# HELP atlantis_project_apply_execution_success atlantis_project_apply_execution_success counter
# TYPE atlantis_project_apply_execution_success counter
atlantis_project_apply_execution_success{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default"} 1

# HELP atlantis_project_apply_execution_time atlantis_project_apply_execution_time summary
# TYPE atlantis_project_apply_execution_time summary
atlantis_project_apply_execution_time{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default",quantile="0.5"} 0.936589625
atlantis_project_apply_execution_time{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default",quantile="0.75"} 0.936589625
atlantis_project_apply_execution_time{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default",quantile="0.95"} 0.936589625
atlantis_project_apply_execution_time{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default",quantile="0.99"} 0.936589625
atlantis_project_apply_execution_time{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default",quantile="0.999"} 0.936589625
atlantis_project_apply_execution_time_sum{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default"} 0.936589625
atlantis_project_apply_execution_time_count{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default"} 1

# HELP atlantis_project_plan_execution_error atlantis_project_plan_execution_error counter
# TYPE atlantis_project_plan_execution_error counter
atlantis_project_plan_execution_error{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default"} 0

# HELP atlantis_project_plan_execution_failure atlantis_project_plan_execution_failure counter
# TYPE atlantis_project_plan_execution_failure counter
atlantis_project_plan_execution_failure{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default"} 0

# HELP atlantis_project_plan_execution_success atlantis_project_plan_execution_success counter
# TYPE atlantis_project_plan_execution_success counter
atlantis_project_plan_execution_success{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default"} 1

# HELP atlantis_project_plan_execution_time atlantis_project_plan_execution_time summary
# TYPE atlantis_project_plan_execution_time summary
atlantis_project_plan_execution_time{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default",quantile="0.5"} 1.26189025
atlantis_project_plan_execution_time{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default",quantile="0.75"} 1.26189025
atlantis_project_plan_execution_time{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default",quantile="0.95"} 1.26189025
atlantis_project_plan_execution_time{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default",quantile="0.99"} 1.26189025
atlantis_project_plan_execution_time{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default",quantile="0.999"} 1.26189025
atlantis_project_plan_execution_time_sum{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default"} 1.26189025
atlantis_project_plan_execution_time_count{base_repo="foouser/foo-repo",pr_number="7",project="atlantis-example-live",project_path="example",terraform_version="1.3.4",workspace="default"} 1

references

closes:

Most metrics have disappeared after version v0.22.0 #3236

relates:

blocked by:

fix(deps): Update Dockerfile curl and libcap #3419

…Runner

albertorm95 · 2023-05-19T09:53:30Z

The image build failed because of this:

atlantis/Dockerfile

Lines 174 to 184 in 6520d71

    
           RUN apk add --no-cache --repository=http://dl-cdn.alpinelinux.org/alpine/edge/main/ \ 
        
                   git~=2.40 && \ 
        
               apk add --no-cache \ 
        
                   ca-certificates~=20230506 \ 
        
                   curl~=8.0 \ 
        
                   unzip~=6.0 \ 
        
                   bash~=5.2 \ 
        
                   openssh~=9.3_p1 \ 
        
                   libcap~=2.68 \ 
        
                   dumb-init~=1.2 \ 
        
                   gcompat~=1.1

#0 3.118 ERROR: unable to select packages:
#0 3.125   curl-8.1.0-r0:
#0 3.125     breaks: world[curl~8.0]
#0 3.125   libcap-2.69-r0:
#0 3.125     breaks: world[libcap~2.68]

nitrocode · 2023-05-19T16:58:32Z

server/events/instrumented_project_command_runner.go

@@ -60,7 +60,7 @@ func (p *InstrumentedProjectCommandRunner) StateRm(ctx command.ProjectContext) c

 func RunAndEmitStats(commandName string, ctx command.ProjectContext, execute func(ctx command.ProjectContext) command.ProjectResult, scope tally.Scope) command.ProjectResult {
 	// ensures we are differentiating between project level command and overall command
-	scope = ctx.SetProjectScopeTags(scope)
+	scope = ctx.SetProjectScopeTags(scope).SubScope(commandName)


Is there a test that we can add to ensure that this functionality doesn't break again in the future?

nitrocode · 2023-05-22T12:51:19Z

Thanks for the fix @albertorm95. Hopefully this works as expected going forward. If you have time, please consider adding a unit test for this in a follow up pr. I wanted to merge since this is a highly requested fix and we're planning to do a release soon.

In the mean time, please use the dev image which should be available about 30 min after this pr merge.

…Runner (runatlantis#3416) Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>

metrics: Fix Add missing project and command scopes to ProjectCommand…

94d8c73

…Runner

albertorm95 requested a review from a team as a code owner May 19, 2023 09:42

github-actions bot added the go Pull requests that update Go code label May 19, 2023

This was referenced May 19, 2023

Most metrics have disappeared after version v0.22.0 #3236

Closed

fix(deps): Update Dockerfile curl and libcap #3419

Merged

nitrocode approved these changes May 19, 2023

View reviewed changes

Merge branch 'main' into fix-add-missing-scopes-to-runner-commands

6f9b4f6

nitrocode reviewed May 19, 2023

View reviewed changes

nitrocode added this to the v0.24.0 milestone May 22, 2023

nitrocode changed the title ~~metrics: Fix Add missing scopes to InstrumentedProjectCommandRunner~~ fix(metrics): add missing stat metric scopes May 22, 2023

nitrocode added the needs tests Change requires tests label May 22, 2023

nitrocode merged commit 96cf388 into runatlantis:main May 22, 2023

albertorm95 deleted the fix-add-missing-scopes-to-runner-commands branch May 22, 2023 13:46

nitrocode mentioned this pull request May 23, 2023

fixbug: Update commandName in RunAndEmitStats #3437

Merged

rkstrickland mentioned this pull request May 23, 2023

v0.24.0 Server Panics with Policy Checks #3439

Closed

mtavaresmedeiros pushed a commit to mtavaresmedeiros/atlantis that referenced this pull request Jul 3, 2023

metrics: Fix Add missing project and command scopes to ProjectCommand…

0d2a002

…Runner (runatlantis#3416) Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>

ijames-gc pushed a commit to gocardless/atlantis that referenced this pull request Feb 13, 2024

metrics: Fix Add missing project and command scopes to ProjectCommand…

20952d2

…Runner (runatlantis#3416) Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>

ijames-gc pushed a commit to gocardless/atlantis that referenced this pull request Feb 13, 2024

metrics: Fix Add missing project and command scopes to ProjectCommand…

cd3f28f

…Runner (runatlantis#3416) Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>

chenrui333 added the metrics label Jun 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(metrics): add missing stat metric scopes #3416

fix(metrics): add missing stat metric scopes #3416

albertorm95 commented May 19, 2023 •

edited

Loading

albertorm95 commented May 19, 2023

nitrocode May 19, 2023

nitrocode commented May 22, 2023

fix(metrics): add missing stat metric scopes #3416

fix(metrics): add missing stat metric scopes #3416

Conversation

albertorm95 commented May 19, 2023 • edited Loading

what

why

tests

references

albertorm95 commented May 19, 2023

nitrocode May 19, 2023

Choose a reason for hiding this comment

nitrocode commented May 22, 2023

albertorm95 commented May 19, 2023 •

edited

Loading