[APM] Endpoints without API tests

[sorenlouv]

How to run API tests

The tests are separated in two suites by license: "trial" (similar to Gold+ license) and "basic". To run the tests you must start the server first, and then run the test runner.

Basic

# Start server
node scripts/functional_tests_server --config x-pack/test/apm_api_integration/basic/config.ts

# Run tests
node scripts/functional_test_runner --config x-pack/test/apm_api_integration/basic/config.ts

The API tests tests for "basic" are located in x-pack/test/apm_api_integration/basic/tests.

Trial

# Start server
node scripts/functional_tests_server --config x-pack/test/apm_api_integration/trial/config.ts

# Run tests
node scripts/functional_test_runner --config x-pack/test/apm_api_integration/trial/config.ts

The API tests tests for "trial" are located in x-pack/test/apm_api_integration/trial/tests.

For debugging access Elasticsearch on http://localhost:9220` (elastic/changeme)

Endpoints in need for tests

Services overview page /app/apm#/services:

• /api/apm/services

Transactions overview page /app/apm#/services/{service.name}/transactions:

• /api/apm/services/{service.name}/agent_name
• /api/apm/services/{service.name}/transaction_groups/charts
• /api/apm/services/{service.name}/transaction_groups
• /api/apm/services/{service.name}/transaction_types
• /api/apm/services/{service.name}/annotation/search
• /api/apm/services/{service.name}/transaction_groups/breakdown
• /api/apm/services/{service.name}/node/{serviceNodeName}/metadata
• /api/apm/services/{serviceName}/transaction_groups/error_rate
• /api/apm/services/{serviceName}/transaction_groups/avg_duration_by_browser

Transactions details page /app/apm#/services/{service.name}/transactions/{transaction.name}:
tbd

Traces overview page (app/apm#/traces)

• /api/apm/traces
• /api/apm/traces/{traceId}

Transaction

• /api/apm/transaction/{traceId}

Errors overview page (/app/apm#/services/{service.name}/errors)

• /api/apm/services/{service.name}/errors/distribution
• /api/apm/services/{service.name}/errors

Errors details page (/app/apm#/services/{service.name}/errors/{error.id})

• /api/apm/services/{service.name}/errors/{error.id}
• /api/apm/services/{service.name}/errors/rate?groupId={error.id}
• /api/apm/services/{service.name}/errors/distribution?groupId={error.id}

Security

• /api/apm/security/indices_privileges

Metrics page (/app/apm#/services/{service.name}/metrics)

• /api/apm/services/{service.name}/metrics/charts

APM Indicies

• /api/apm/settings/apm-index-settings

Custom links

• /api/apm/settings/custom_links/transaction

Anomaly detection

• /api/apm/settings/anomaly-detection
• /api/apm/settings/anomaly-detection/jobs
• /api/apm/settings/anomaly-detection/environments

Service Map

• /api/apm/service-map
• /api/apm/service-map/service/{serviceName}

Service nodes

• /api/apm/services/{serviceName}/serviceNodes

UI Filters

• /api/apm/ui_filters/environments
• /api/apm/ui_filters/local_filters/metrics
• /api/apm/ui_filters/local_filters/errorGroups
• /api/apm/ui_filters/local_filters/traces
• /api/apm/ui_filters/local_filters/services

index pattern

• /api/apm/index_pattern/static
• /api/apm/index_pattern/dynamic
• /api/apm/index_pattern/title

Observability dashboard

• /api/apm/observability_dashboard/has_data
• /api/apm/observability_dashboard

[elasticmachine]

Pinging @elastic/apm-ui (Team:apm)

[matjahs]

Is help still required? Would love to contribute!

[sorenlouv]

Hi @Raven283

Yes, help would be much appreciated. As you can see many of our API's are not covered by api tests. We'd like to change that :)

The easiest way to get started is probably to look at one of the existing tests. Elasticsearch can be populated with sample data (this is very useful) like this:

before(() => esArchiver.load('8.0.0'));
after(() => esArchiver.unload('8.0.0'));

Any of the unchecked items on the list needs test. For instance /api/apm/services/{service.name}/transaction_groups/breakdown or /api/apm/security/indices_privileges.

Let me know if you have any questions. And thanks for reaching out!

[AnshuOnGit]

I would like to contribute towards this. Is it still available?

[matjahs]

@AnshuOnGit I've started at the top of the list. If you start at about halfway (APM indices) and work your way down we shouldn't get in each others way :)

[sorenlouv]

@Raven283 That's great to hear 👍 👍 Please open a PR sooner rather than later to avoid conflicts.

[sorenlouv]

No need to track this anymore