Skip to content

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

Merged
nitrocode merged 2 commits intorunatlantis:mainfrom
albertorm95:fix-add-missing-scopes-to-runner-commands
May 22, 2023
Merged

fix(metrics): add missing stat metric scopes#3416
nitrocode merged 2 commits intorunatlantis:mainfrom
albertorm95:fix-add-missing-scopes-to-runner-commands

Conversation

@albertorm95
Copy link
Copy Markdown
Contributor

@albertorm95 albertorm95 commented May 19, 2023 •
edited
Loading

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:

relates:

blocked by:

@albertorm95 albertorm95 requested a review from a team as a code owner May 19, 2023 09:42
@github-actions github-actions Bot added the go Pull requests that update Go code label May 19, 2023
@albertorm95
Copy link
Copy Markdown
Contributor Author

albertorm95 commented May 19, 2023

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]

This was referenced May 19, 2023
Closed
Merged
nitrocode
nitrocode reviewed May 19, 2023
View reviewed changes
Comment thread server/events/instrumented_project_command_runner.go
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)
Copy link
Copy Markdown
Member

@nitrocode nitrocode May 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@nitrocode nitrocode added this to the v0.24.0 milestone May 22, 2023
@nitrocode nitrocode changed the title metrics: Fix Add missing scopes to InstrumentedProjectCommandRunner fix(metrics): add missing stat metric scopes May 22, 2023
@nitrocode nitrocode added the needs tests Change requires tests label May 22, 2023
@nitrocode nitrocode merged commit 96cf388 into runatlantis:main May 22, 2023
@nitrocode
Copy link
Copy Markdown
Member

nitrocode commented May 22, 2023

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.

@albertorm95 albertorm95 deleted the fix-add-missing-scopes-to-runner-commands branch May 22, 2023 13:46
@nitrocode nitrocode mentioned this pull request May 23, 2023
Merged
@rkstrickland rkstrickland mentioned this pull request May 23, 2023
Closed
mtavaresmedeiros pushed a commit to mtavaresmedeiros/atlantis that referenced this pull request Jul 3, 2023
@albertorm95 @nitrocode
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
@albertorm95 @nitrocode @ijames-gc
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
@albertorm95 @nitrocode @ijames-gc
metrics: Fix Add missing project and command scopes to ProjectCommand…
cd3f28f 
…Runner (runatlantis#3416)

Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nitrocode nitrocode nitrocode approved these changes

Assignees

No one assigned

Labels

go Pull requests that update Go code metrics needs tests Change requires tests

Projects

None yet

Milestone

v0.24.0

Development

Successfully merging this pull request may close these issues.

3 participants

@albertorm95 @nitrocode @chenrui333