Skip to content

[observability] [apm] Reorg files #1069

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

Merged
merged 6 commits into from
Apr 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ Data volumes for ingest and retention are based on the fully enriched normalized

## Synthetics [synthetics-billing]

[Synthetic monitoring](../../../solutions/observability/apps/synthetic-monitoring.md) is an optional add-on to Observability Serverless projects that allows you to periodically check the status of your services and applications. In addition to the core ingest and retention dimensions, there is a charge to execute synthetic monitors on our testing infrastructure. Browser (journey) based tests are charged per-test-run, and ping (lightweight) tests have an all-you-can-use model per location used.
[Synthetic monitoring](/solutions/observability/synthetics/index.md) is an optional add-on to Observability Serverless projects that allows you to periodically check the status of your services and applications. In addition to the core ingest and retention dimensions, there is a charge to execute synthetic monitors on our testing infrastructure. Browser (journey) based tests are charged per-test-run, and ping (lightweight) tests have an all-you-can-use model per location used.

Refer to [Serverless billing dimensions](serverless-project-billing-dimensions.md) and the [{{ecloud}} pricing table](https://cloud.elastic.co/cloud-pricing-table?productType=serverless&project=observability) for more details about {{obs-serverless}} billing dimensions and rates.
2 changes: 1 addition & 1 deletion deploy-manage/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This section focuses on deploying and managing {{es}} and {{kib}}, as well as su

To learn how to deploy optional {{stack}} components, refer to the following sections:
* [Fleet and Elastic Agent](/reference/fleet/index.md)
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
* [APM](/solutions/observability/apm/index.md)
* [Beats](beats://reference/index.md)
* [Logstash](logstash://reference/index.md)
:::
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/_snippets/installation-order.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ If you're deploying the {{stack}} in a self-managed cluster, then install the {{
* [{{kib}}](/deploy-manage/deploy/self-managed/install-kibana.md)
* [Logstash](logstash://reference/index.md)
* [{{agent}}](/reference/fleet/index.md) or [Beats](beats://reference/index.md)
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
* [APM](/solutions/observability/apm/index.md)
* [{{es}} Hadoop](elasticsearch-hadoop://reference/index.md)

Installing in this order ensures that the components each product depends on are in place.
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/_snippets/other-apis.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Some other Elastic products have APIs to support machine-to-machine operations:

* [APM event intake API](/solutions/observability/apps/elastic-apm-events-intake-api.md)
* [APM event intake API](/solutions/observability/apm/elastic-apm-events-intake-api.md)
* [Fleet APIs](/reference/fleet/fleet-api-docs.md)
* [Logstash APIs](logstash://reference/monitoring-logstash.md)
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Refer to [](./working-with-deployments.md) for additional actions and configurab

You might want to change the configuration of your deployment to:

* Add features, such as [machine learning](/explore-analyze/machine-learning.md) or [APM (application performance monitoring)](/solutions/observability/apps/application-performance-monitoring-apm.md).
* Add features, such as [machine learning](/explore-analyze/machine-learning.md) or [APM (application performance monitoring)](/solutions/observability/apm/index.md).
* [Increase or decrease capacity](./resize-deployment.md) by changing the amount of reserved memory and storage for different parts of your deployment.
* Enable [autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md) so that the available resources for deployment components, such as [data tiers](/manage-data/lifecycle/data-tiers.md) and machine learning nodes, adjust automatically as the demands on them change over time.
* Enable [high availability](./ece-ha.md), also known as fault tolerance, by adjusting the number of availability zones that parts of your deployment run on.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Starting in {{stack}} version 8.0, how you change APM settings and the settings
: New deployments created in {{stack}} version 8.0 and later will be managed by {{fleet}}.

* This mode requires SSL/TLS configuration. Check [TLS configuration for {{fleet}}-managed mode](#ece-edit-apm-fleet-tls) for details.
* Check [APM integration input settings](/solutions/observability/apps/configure-apm-server.md) for all other Elastic APM configuration options in this mode.
* Check [APM integration input settings](/solutions/observability/apm/configure-apm-server.md) for all other Elastic APM configuration options in this mode.


Standalone APM Server (legacy)
Expand All @@ -24,7 +24,7 @@ Standalone APM Server (legacy)
Check [Edit standalone APM settings (legacy)](#ece-edit-apm-standalone-settings-ece)for information on how to configure Elastic APM in this mode.


To learn more about the differences between these modes, or to switch from Standalone APM Server (legacy) mode to {{fleet}}-managed, check [Switch to the Elastic APM integration](/solutions/observability/apps/switch-to-elastic-apm-integration.md).
To learn more about the differences between these modes, or to switch from Standalone APM Server (legacy) mode to {{fleet}}-managed, check [Switch to the Elastic APM integration](/solutions/observability/apm/switch-to-elastic-apm-integration.md).


## TLS configuration for {{fleet}}-managed mode [ece-edit-apm-fleet-tls]
Expand All @@ -42,7 +42,7 @@ Pick one of the following options:
{{ece}} supports most of the legacy APM settings. Through a YAML editor in the console, you can append your APM Server properties to the `apm-server.yml` file. Your changes to the configuration file are read on startup.

::::{important}
Be aware that some settings could break your cluster if set incorrectly and that the syntax might change between major versions. Before upgrading, be sure to review the full list of the [latest APM settings and syntax](/solutions/observability/apps/configure-apm-server.md).
Be aware that some settings could break your cluster if set incorrectly and that the syntax might change between major versions. Before upgrading, be sure to review the full list of the [latest APM settings and syntax](/solutions/observability/apm/configure-apm-server.md).
::::


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ mapped_pages:

# Manage your Integrations Server [ece-manage-integrations-server]

For deployments that are version 8.0 and later, you have the option to add a combined [Application Performance Monitoring (APM) Server](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Fleet Server](/reference/fleet/index.md) to your deployment. APM allows you to monitor software services and applications in real time, turning that data into documents stored in the {{es}} cluster. Fleet allows you to centrally manage Elastic Agents on many hosts.
For deployments that are version 8.0 and later, you have the option to add a combined [Application Performance Monitoring (APM) Server](/solutions/observability/apm/index.md) and [Fleet Server](/reference/fleet/index.md) to your deployment. APM allows you to monitor software services and applications in real time, turning that data into documents stored in the {{es}} cluster. Fleet allows you to centrally manage Elastic Agents on many hosts.

As part of provisioning, the APM Server and Fleet Server are already configured to work with {{es}} and {{kib}}. At the end of provisioning, you are shown the secret token to configure communication between the APM Server and the backend [APM Agents](https://www.elastic.co/guide/en/apm/agent/index.html). The APM Agents get deployed within your services and applications.

Expand All @@ -23,7 +23,7 @@ From the deployment **Integrations Server** page you can also:
* Fully remove the Integrations Server, delete it from the disk, and stop the charges.

::::{important}
The APM secret token can no longer be reset from the {{ece}} UI. Check [Secret token](/solutions/observability/apps/secret-token.md) for instructions on managing a secret token. Note that resetting the token disrupts your APM service and restarts the server. When the server restarts, you’ll need to update all of your agents with the new token.
The APM secret token can no longer be reset from the {{ece}} UI. Check [Secret token](/solutions/observability/apm/secret-token.md) for instructions on managing a secret token. Note that resetting the token disrupts your APM service and restarts the server. When the server restarts, you’ll need to update all of your agents with the new token.
::::

## Routing to Fleet Server [ece-integrations-server-fleet-routing]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This example shows how to use the {{ece}} RESTful API to switch from using [APM

Given a deployment that is using an APM & Fleet Server with {{stack}} version 8.0 or later, it is possible to start using Integrations Server instead by updating the deployment with an Integrations Server payload. Switching from APM & Fleet Server to Integrations Server in this way ensures that the endpoints and credentials currently used by APM Server and Fleet Server remain the same after the switch.

In order to start using the Integrations Server payload, you first need to enable the APM integration for Elastic Agent by following the steps in [Switch to the Elastic APM integration](/solutions/observability/apps/switch-an-elastic-cloud-cluster-to-apm-integration.md).
In order to start using the Integrations Server payload, you first need to enable the APM integration for Elastic Agent by following the steps in [Switch to the Elastic APM integration](/solutions/observability/apm/switch-an-elastic-cloud-cluster-to-apm-integration.md).


## API request example [ece_api_request_example_3]
Expand Down
4 changes: 2 additions & 2 deletions deploy-manage/deploy/cloud-on-k8s/advanced-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This section covers the following topics:

## Use APM Agent central configuration [k8s-apm-agent-central-configuration]

[APM Agent configuration management](/solutions/observability/apps/apm-agent-central-configuration.md) [7.5.1] allows you to configure your APM Agents centrally from the {{kib}} APM app. To use this feature, the APM Server needs to be configured with connection details of the {{kib}} instance. If {{kib}} is managed by ECK, you can simply add a `kibanaRef` attribute to the APM Server specification:
[APM Agent configuration management](/solutions/observability/apm/apm-agent-central-configuration.md) [7.5.1] allows you to configure your APM Agents centrally from the {{kib}} APM app. To use this feature, the APM Server needs to be configured with connection details of the {{kib}} instance. If {{kib}} is managed by ECK, you can simply add a `kibanaRef` attribute to the APM Server specification:

```yaml
cat <<EOF | kubectl apply -f -
Expand Down Expand Up @@ -105,7 +105,7 @@ The APM Server keystore can be used to store sensitive settings in the APM Serve
password: "${ES_PASSWORD}"
```

3. Reference the key in the APM Server configuration, as described in the [Secrets keystore for secure settings](/solutions/observability/apps/secrets-keystore-for-secure-settings.md).
3. Reference the key in the APM Server configuration, as described in the [Secrets keystore for secure settings](/solutions/observability/apm/secrets-keystore-for-secure-settings.md).


## Reference an existing {{es}} cluster [k8s-apm-existing-es]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ Deploys single instance {{agent}} Deployment in {{fleet}} mode with APM integrat
kubectl apply -f https://raw.githubusercontent.com/elastic/cloud-on-k8s/2.16/config/recipes/elastic-agent/synthetic-monitoring.yaml
```

Deploys an {{fleet}}-enrolled {{agent}} that can be used as for [Synthetic monitoring](/solutions/observability/apps/synthetic-monitoring.md). This {{agent}} uses the `elastic-agent-complete` image. The agent policy still needs to be [registered as private location](/solutions/observability/apps/monitor-resources-on-private-networks.md#synthetics-private-location-add) in {{kib}}.
Deploys an {{fleet}}-enrolled {{agent}} that can be used as for [Synthetic monitoring](/solutions/observability/synthetics/index.md). This {{agent}} uses the `elastic-agent-complete` image. The agent policy still needs to be [registered as private location](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add) in {{kib}}.
2 changes: 1 addition & 1 deletion deploy-manage/deploy/cloud-on-k8s/connect-to-apm-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ For more information, check [APM Server Reference](https://www.elastic.co/guide/

## APM Server API keys [k8s-apm-api-keys]

If you want to configure API keys to authorize requests to the APM Server, instead of using the APM Server CLI, you have to create API keys using the {{es}} [create API key API](https://www.elastic.co/guide/en/elasticsearch/reference/7.14/security-api-create-api-key.html), check the [APM Server documentation](/solutions/observability/apps/api-keys.md).
If you want to configure API keys to authorize requests to the APM Server, instead of using the APM Server CLI, you have to create API keys using the {{es}} [create API key API](https://www.elastic.co/guide/en/elasticsearch/reference/7.14/security-api-create-api-key.html), check the [APM Server documentation](/solutions/observability/apm/api-keys.md).


Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ mapped_pages:

# Use an {{es}} cluster managed by ECK [k8s-apm-eck-managed-es]

Managing APM Server, {{kib}} and {{es}} with ECK allows a smooth and secured integration between the stack components. The output configuration of the APM Server is setup automatically to establish a trust relationship with {{es}}. Specifying the {{kib}} reference allows ECK to automatically configure the [{{kib}} endpoint](/solutions/observability/apps/configure-kibana-endpoint.md).
Managing APM Server, {{kib}} and {{es}} with ECK allows a smooth and secured integration between the stack components. The output configuration of the APM Server is setup automatically to establish a trust relationship with {{es}}. Specifying the {{kib}} reference allows ECK to automatically configure the [{{kib}} endpoint](/solutions/observability/apm/configure-kibana-endpoint.md).

1. To deploy an APM Server and connect it to the {{es}} cluster and {{kib}} instance you created in the [quickstart](deploy-an-orchestrator.md), apply the following specification:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,26 +103,26 @@ This table compares Observability capabilities between {{ech}} deployments and S
|---------|----------------------|-----------------------------------|------------------|
| [**AI Assistant**](/solutions/observability/observability-ai-assistant.md) | ✅ | ✅ | |
| **APM integration** | ✅ | ✅ | Use **Managed Intake Service** (supports Elastic APM and OTLP protocols) |
| [**APM Agent Central Configuration**](/solutions/observability/apps/apm-agent-central-configuration.md) | ✅ | ❌ | Not available in Serverless |
| [**APM Tail-based sampling**](/solutions/observability/apps/transaction-sampling.md#apm-tail-based-sampling) | ✅ | ❌ | - Not available in Serverless <br>- Consider **OpenTelemetry** tail sampling processor as an alternative |
| [**APM Agent Central Configuration**](/solutions/observability/apm/apm-agent-central-configuration.md) | ✅ | ❌ | Not available in Serverless |
| [**APM Tail-based sampling**](/solutions/observability/apm/transaction-sampling.md#apm-tail-based-sampling) | ✅ | ❌ | - Not available in Serverless <br>- Consider **OpenTelemetry** tail sampling processor as an alternative |
| [**Android agent/SDK instrumentation**](apm-agent-android://reference/index.md) | ✅ | ❌ | Not available in Serverless |
| [**AWS Firehose integration**](/solutions/observability/cloud/monitor-amazon-web-services-aws-with-amazon-data-firehose.md) | ✅ | ✅ | |
| **Custom roles for Kibana Spaces** | ✅ | **Planned** | Anticipated in a future release |
| [**Data stream lifecycle**](/manage-data/lifecycle/data-stream.md) | ✅ | ✅ | Primary lifecycle management method in Serverless |
| **[Elastic Serverless Forwarder](elastic-serverless-forwarder://reference/index.md)** | ✅ | ❌ | |
| **[Elastic Synthetics Private Locations](/solutions/observability/apps/monitor-resources-on-private-networks.md#synthetics-private-location-add)** | ✅ | ✅ | |
| **[Elastic Synthetics Private Locations](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add)** | ✅ | ✅ | |
| **[Fleet Agent policies](/reference/fleet/agent-policy.md)** | ✅ | ✅ | |
| **[Fleet server](/reference/fleet/fleet-server.md)** | - Self-hosted <br>- Hosted | ✅ | Fully managed by Elastic |
| [**Index lifecycle management**](/manage-data/lifecycle/index-lifecycle-management.md) | ✅ | ❌ | Use [**Data stream lifecycle**](/manage-data/lifecycle/data-stream.md) instead |
| **[iOS agent/SDK instrumentation](apm-agent-ios://reference/index.md)** | ✅ | ❌ | Not available in Serverless |
| **[Kibana Alerts](/deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts.md)** | ✅ | ✅ | |
| **[LogsDB index mode](/manage-data/data-store/data-streams/logs-data-stream.md)** | ✅ | ✅ | - Reduces storage footprint <br> - Enabled by default <br>- Cannot be disabled |
| **[Logs management](/solutions/observability/logs.md)** | ✅ | ✅ | |
| **[Metrics monitoring](/solutions/observability/apps/metrics.md)** | ✅ | ✅ | |
| **[Metrics monitoring](/solutions/observability/apm/metrics.md)** | ✅ | ✅ | |
| **[Observability SLO](/solutions/observability/incident-management/service-level-objectives-slos.md)** | ✅ | ✅ | |
| [**Real User Monitoring (RUM)**](/solutions/observability/apps/real-user-monitoring-user-experience.md) | ✅ | **Planned** | Anticipated in a future release |
| [**Real User Monitoring (RUM)**](/solutions/observability/applications/user-experience.md) | ✅ | **Planned** | Anticipated in a future release |
| **[Universal Profiling](/solutions/observability/infra-and-hosts/get-started-with-universal-profiling.md)** | ✅ | ❌ | Not available in Serverless |
| **Uptime monitoring** | ❌ | ❌ | - Deprecated in all deployment types <br>- Use [**Synthetics app**](/solutions/observability/apps/synthetic-monitoring.md) instead |
| **Uptime monitoring** | ❌ | ❌ | - Deprecated in all deployment types <br>- Use [**Synthetics app**](/solutions/observability/synthetics/index.md) instead |

### Security

Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/elastic-cloud/edit-stack-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,4 @@ If a setting is not supported by {{ech}}, you will get an error message when you
## Edit APM user settings [ec-manage-apm-settings]

Change how Elastic APM runs by providing your own user settings.
Check [APM configuration reference](/solutions/observability/apps/configure-apm-server.md) for information on how to configure the {{fleet}}-managed APM integration.
Check [APM configuration reference](/solutions/observability/apm/configure-apm-server.md) for information on how to configure the {{fleet}}-managed APM integration.
2 changes: 1 addition & 1 deletion deploy-manage/deploy/elastic-cloud/heroku.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Not all features of {{ecloud}} are available to Heroku users. Specifically, you

Generally, if a feature is shown as available in the [{{heroku}} console](https://cloud.elastic.co?page=docs&placement=docs-body), you can use it.

[{{es}} Machine Learning](https://www.elastic.co/guide/en/machine-learning/current/index.html), [Elastic APM](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Elastic Fleet Server](https://www.elastic.co/guide/en/fleet/current/fleet-overview.html) are not supported by the {{es}} Add-On for Heroku.
[{{es}} Machine Learning](https://www.elastic.co/guide/en/machine-learning/current/index.html), [Elastic APM](/solutions/observability/apm/index.md) and [Elastic Fleet Server](https://www.elastic.co/guide/en/fleet/current/fleet-overview.html) are not supported by the {{es}} Add-On for Heroku.

For other restrictions that apply to all of {{ecloud}}, refer to [](/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md).

Expand Down
Loading
Loading