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.

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

feat(jans-cedarling): add an example that runs profiling #10979

Merged
merged 4 commits into from
Mar 7, 2025

Conversation

rmarinn
Copy link
Contributor

@rmarinn rmarinn commented Mar 4, 2025

Prepare


Description

This PR adds an example that runs profiling while calling Cedarling::authorize then

  1. writes the output to the stdout (hard for humans to read)
  2. saves an SVG file at jans_cedarling/cedarling_profiling_flamegraph.svg (easier for humans to read)

Target issue

target issue: #10978

closes #10978

Implementation Details

Use this command to run the example:

cargo run --example profiling

Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

  • I confirm that there is no impact on the docs due to the code changes in this PR.

@rmarinn rmarinn self-assigned this Mar 4, 2025
@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-jans-cedarling Touching folder /jans-cedarling kind-feature Issue or PR is a new feature request labels Mar 4, 2025
@rmarinn rmarinn enabled auto-merge (squash) March 4, 2025 09:57
Copy link
Contributor

@duttarnab duttarnab left a comment

Choose a reason for hiding this comment

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

I think we should add a section in the README or docs explaining how the profiling data/graph can be used for optimizing the project further.

@rmarinn
Copy link
Contributor Author

rmarinn commented Mar 7, 2025

I think we should add a section in the README or docs explaining how the profiling data/graph can be used for optimizing the project further.

honestly, i think it's pretty explanatory... the longer the bars in the graph, the longer it takes to run. and the bars are labeled with the function names.

@rmarinn rmarinn merged commit dc38e10 into main Mar 7, 2025
1 check passed
@rmarinn rmarinn deleted the jans-cedarling-10978 branch March 7, 2025 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Documentation needs to change as part of issue or PR comp-jans-cedarling Touching folder /jans-cedarling kind-feature Issue or PR is a new feature request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat(jans-cedarling): add an example that runs profiling
5 participants