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.

Sign up for GitHub

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

[APM] Add missing settings to documentation #161603

Merged
merged 7 commits into from
Jul 13, 2023
Merged

[APM] Add missing settings to documentation #161603

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3fb87b8
add all apm settings
bmorelli25 Jul 10, 2023
83e77a8
add observability settings codeowner
bmorelli25 Jul 10, 2023
70a82de
Merge branch 'main' into sync-settings
bmorelli25 Jul 10, 2023
9024ffe
Merge branch 'main' into sync-settings
bmorelli25 Jul 11, 2023
f1a138d
Update docs/management/advanced-options.asciidoc
bmorelli25 Jul 13, 2023
0b13b98
Merge branch 'main' into sync-settings
bmorelli25 Jul 13, 2023
69c5c20
Update docs/settings/apm-settings.asciidoc
bmorelli25 Jul 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/CODEOWNERS
View file
Open in desktop
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -874,7 +874,6 @@ x-pack/plugins/infra/server/lib/alerting @elastic/actionable-observability
/x-pack/test/alerting_api_integration/observability/synthetics_rule.ts @elastic/uptime
/x-pack/test/alerting_api_integration/observability/index.ts @elastic/uptime


# Client Side Monitoring / Uptime (lives in APM directories but owned by Uptime)
/x-pack/plugins/apm/public/application/uxApp.tsx @elastic/uptime
/x-pack/plugins/apm/public/components/app/rum_dashboard @elastic/uptime
Expand All @@ -884,6 +883,9 @@ x-pack/plugins/infra/server/lib/alerting @elastic/actionable-observability
/x-pack/plugins/observability_shared/public/components/tour @elastic/platform-onboarding
/x-pack/test/functional/apps/infra/tour.ts @elastic/platform-onboarding

# Observability settings
/x-pack/plugins/observability/server/ui_settings.ts @elastic/obs-docs

### END Observability Plugins

# Presentation
Expand Down
26 changes: 26 additions & 0 deletions docs/management/advanced-options.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,26 @@ value is 10000.
[[apm-enable-service-overview]]`apm:enableServiceOverview`::
When enabled, displays the *Overview* tab for services in *APM*.

[[apm-agent-explorer]]`observability:apmAgentExplorerView`::
beta:[] Enables the Agent explorer view.

[[apm-aws-price]]`observability:apmAWSLambdaPriceFactor`::
Set the price per Gb-second for your AWS Lambda functions.

[[apm-aws-request]]`observability:apmAWSLambdaRequestCostPerMillion`::
??
Copy link
Member Author

Choose a reason for hiding this comment

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

@cauemarcondes what does this config do? I couldn't figure it out.

Copy link
Member

Choose a reason for hiding this comment

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

It's used to calculate the cost running on serverless:

kibana/x-pack/plugins/apm/server/routes/metrics/serverless/helper.ts

Lines 90 to 92 in 5fca22a

const estimatedCost =
computeUsageGbSec * priceFactor +
transactionThroughput * (awsLambdaRequestCostPerMillion / 1000000);

The price is the number of requests (throughput) multipled with the AWS Lambda request cost (currently the monthly request price is $0.20 per one million request)

bmorelli25 marked this conversation as resolved.
Show resolved Hide resolved

[[apm-continuous-rollups]]`observability:apmEnableContinuousRollups`::
beta:[] When continuous rollups is enabled, the UI will select metrics with the appropriate resolution.
On larger time ranges, lower resolution metrics will be used, which will improve loading times.

[[apm-enable-service-metrics]]`observability:apmEnableServiceMetrics`::
beta:[] Enables the usage of service transaction metrics, which are low cardinality metrics that can be used by certain views like the service inventory for faster loading times.

[[observability-apm-labs]]`observability:apmLabsButton`::
Enable or disable the APM Labs button -- a quick way to enable and disable technical preview features in APM.
See <<apm-labs>> to learn more.

[[observability-apm-critical-path]]`observability:apmEnableCriticalPath`::
When enabled, displays the critical path of a trace.

Expand All @@ -401,9 +421,15 @@ preview:[] When enabled, uses progressive loading of some APM views.
Data may be requested with a lower sampling rate first, with lower accuracy but faster response times,
while the unsampled data loads in the background.

[[observability-apm-max-groups]]`observability:apmServiceGroupMaxNumberOfServices`::
Limit the number of services in a given service group.

[[observability-apm-optimized-sort]]`observability:apmServiceInventoryOptimizedSorting`::
preview:[] Sorts services without anomaly detection rules on the APM Service inventory page by service name.

[[observability-default-service-env]]`observability:apmDefaultServiceEnvironment`::
Set the default environment for the APM app. When left empty, data from all environments will be displayed by default.

[[observability-enable-aws-lambda-metrics]]`observability:enableAwsLambdaMetrics`::
preview:[] Display Amazon Lambda metrics in the service metrics tab.

Expand Down
1 change: 1 addition & 0 deletions docs/settings/apm-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ If you'd like to change any of the default values,
copy and paste the relevant settings into your `kibana.yml` configuration file.
Changing these settings may disable features of the APM App.

TIP: More settings are available in the <<Observability advanced settings,observability-advanced-settings>>.
bmorelli25 marked this conversation as resolved.
Show resolved Hide resolved

`xpack.apm.maxSuggestions` {ess-icon}::
Maximum number of suggestions fetched in autocomplete selection boxes. Defaults to `100`.
Expand Down