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

ci: Set up AppMap #6

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

ci: Set up AppMap #6

wants to merge 8 commits into from

Conversation

Daniel-Warner-X
Copy link
Owner

This pull request was created by the AppMap CI setup assistant.

To continue, return to https://getappmap.com/setup/github_auto/progress.

Steps to merge:

  • Review the automated commit which adds the AppMap language agent and appmap.yml.
  • Review the "AppMap configuration report" generated by the workflow run.

Copy link

AppMap configuration report

Success! Your project has been successfully configured to record AppMaps when
you run your tests.

Continue with AppMap Setup >>


The following sections contain detailed information about the AppMap integration with your project.

AppMap data sources

In GitHub Actions and other CI systems, AppMaps are created by recording
test cases. Here's how the AppMaps in this project were created:

Number of AppMaps Type of recording
1 rspec

Code recording settings

Your appmap.yml configuration file specifies all the code that you want AppMap to instrument and record.
By default, sub-modules of any requested code are recorded as well. In this project, the packages specified
in appmap.yml are:

[]

By applying this configuration to your ruby project, AppMap has recorded the
following packages and modules:

Web service API profile

When you record AppMaps that include HTTP server requests, AppMap automatically generates OpenAPI definitions
based on the observed data.

0% of the AppMaps in this project contain at least one HTTP server request.

0% of the AppMaps in this project contain more than one HTTP server request.

Here's a summary of the web service routes that are provided by this project:

And here are the different content types served by the API:

Response Content Type Number of Routes

As you change your code and tests, AppMap will automatically update the OpenAPI definitions.
You'll see a summary of the REST API changes in each pull request.

SQL profile

When your code makes a SQL query, AppMap records the SQL query in detail. It even parses the queries
to figure out which tables your app is using, and how it's using them.

0% of the AppMaps in this project contain at least one SQL query.

0% of the AppMaps in this project contain more than one SQL query.

Large AppMaps

Some tests can produce large AppMaps, because they exercise longer or highly repeated code paths.
AppMap runtime code review is optimized for AppMaps that
are less than 10 MB in size. You may want to consider disabling AppMap for tests that produce
large AppMaps, since they can slow down your CI job and they are hard to analyze. Also, note that
AppMaps greater than 50 MB in size will not be analyzed at all.

You can disable recording of a test case by adding a code comment or annotation to the test case file.
Learn how by visiting the
reference documentation for appmap-ruby.

This project doesn't have any AppMaps that are greater than 1 MB in size.

Frequently recorded functions

The AppMap configuration file appmap.yml specifies which functions to record.
Some functions may be called very frequently, adding little to the understandability of the code
while adding a lot of overhead to the AppMap recording process.

Note that some functions are automatically added to the recording by
the AppMap agent. For example, the AppMap agent automatically records functions that are
relevant to detecting security flaws and performance problems. If you disable recording of these
functions, then some problems may become undetectable.

You can disable recording of a class or function by updating the appmap.yml configuration file.
Learn how by visiting the
reference documentation for appmap-ruby.

This project doesn't have any recorded functions that occur more than 1000 times.

Learn more

To learn more about AppMap, visit
appmap.io/docs.

Copy link

AppMap project summary

AppMap runtime code review scans the AppMaps for security flaws, performance
problems, and code anti-patterns. When you use AppMap runtime code review on a pull request,
only the new problems and resolved problems are shown in the report.

AppMap didn't detect any flaws or problems in the runtime code review of your project.

Note that AppMap runtime code review is optimized for projects that use SQL databases,
serve HTTP requests, and make HTTP client requests to other services.

If your project doesn't do any of these things, then AppMap runtime code review will be primarily
useful for:

  • Fixing broken test cases.
  • Determining whether a pull request has new test cases, and if so, what they do.
  • Reviewing AppMaps of new and changed test cases

Copy link

AppMap runtime code review

Summary Status
Failed tests ✅ All tests passed
API changes 0️⃣ No API changes
Security flaws ✅ None detected
Performance problems ✅ None detected
Code anti-patterns ✅ None detected
New AppMaps 0️⃣ No new AppMaps

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant