Skip to content

Commit 244bbf2

Browse files
committed
APM LZ-addon updates
1 parent e70653c commit 244bbf2

File tree

4 files changed

+11
-25
lines changed

4 files changed

+11
-25
lines changed

manageability-and-operations/observability-and-manageability/application-performance-monitoring/LZ-addons/README.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,14 @@
11
# **[OCI Landing Zone Application Performance Monitoring Service](#)**
22
## **An OCI Open LZ Addon to enable Application Performance Monitoring in your LZ**
33
 
4-
5-
This landing zone add-on provides the necessary configuration steps to enable OCI Application Performance Monitoring (OCI APM). OCI APM offers tools to collect and explore frontend-to-backend traces of application operations to locate performance bottlenecks and dependencies.
4+
This landing zone add-on provides the necessary configuration steps to enable OCI Application Performance Monitoring (OCI APM).
65

76
|Step | Name| Link|
87
|---|---|---|
9-
| 1 | Design Decisions | Link |
10-
| 2 | WIP | Coming Soon |
11-
| 3 | WIP| Coming Soon |
12-
| 4 | WIP | Coming Soon|
8+
| 1 | [Design Decisions](apm-lz-design-decisions.md) | Link |
9+
| 2 | [Deployment Scenario](./apm-lz-deployment-scenario.md) | Coming Soon |
1310
 
1411

15-
## 3. Deployment Scenario
16-
17-
Based on the outlined design decisions, a basic deployment of OCI APM will look like the blueprint below:
18-
19-
ADD BLUEPRINT IMAGE
20-
 
21-
22-
An APM domain is deployed with its own Oracle-managed storage and data uploadd endpoint accessible from within the OCI service network as opposed to customer-managed virtual cloud networks (VCN). This means data sources collecting front-end and back-end telemetry will need to be able to reach the domain endpoint ending in "oci.oraclecloud.com" via HTTPS (Port 443) - either over the internet, through a proxy, or via the OCI service gateway if the application services run in OCI VCNs. All data transmissions are egress-only, meaning no ports need to be opened to allow ingress traffic for the data sources on clients, servers or containers.
23-
24-
All data sources need to use data keys belonging to the APM domain endpoint for validation before upload. The public data key is used for the browser agent while the private data key is used for back-end data sources. The reason there are two types of keys is due to the nature of the browser agent and front-end monitoring done with JavaScript. The code including the data key is exposed to any browser loading it when visiting a monitored web page. This is different from back-end spans instrumented by data sources only exposed to anyone with private access to the application server or container. For this reason, back-end spans are validated with a private key not exposed in browsers. See [here](https://docs.oracle.com/en-us/iaas/application-performance-monitoring/doc/obtain-data-upload-endpoint-and-data-keys.html) for more.
25-
26-
When the domain is created and data sources are configured to transfer data, additional configurations to any of these can be made as outlined in section 2.
27-
2812
# License
2913

3014
Copyright (c) 2025 Oracle and/or its affiliates.

manageability-and-operations/observability-and-manageability/application-performance-monitoring/LZ-addons/apm-lz-design-decisions.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## **Design Decisions During Setup of OCI Application Performance Monitoring**
33
 
44

5-
To configure this add-on for OCI Application Performance Monitoring (OCI APM), you will need to make some key design decisions:
5+
To setup and configure OCI Application Performance Monitoring (OCI APM), you will need to make some key design decisions:
66

77
* **Domains**. Create one APM domain per application to segregate trace data. As an optional extension, configure APM domain(s) to adjust trace data and metrics for analysis and alerting purposes.
88

@@ -13,11 +13,11 @@ To configure this add-on for OCI Application Performance Monitoring (OCI APM), y
1313
* **Alarms**. Determine performance indicators of application(s) and define appropriate alarms for these in accordance to available metrics and dimensions.
1414
 
1515

16-
### 2.1 Domains
16+
### Domains
1717

1818
Domains contain all trace data explored in APM. It's recommended to create one APM domain per application to segregate trace data. This means that traces from one applications are not mixed with the traces of another application when analyzing performance bottlenecks and their root causes.
1919

20-
Cost in APM is based on ingested spans per hour. Assuming all domains will receive trace data continuously, spreading the ingested spans over more than one domain will not affect the overall cost of APM compared to centralizing spans in one domain.
20+
![OCI APM Domain](../images/apm_domain.png)
2121

2222
To test APM with applications and estimate hourly cost, it's recommended to start out with a free domain before a paid domain. A free domain limits hourly span ingestions and availability monitor executions to 1,000 and 10 respectively. However, a free domain also lets you test out all APM features and estimate cost in paid domains by calculating hourly average of ingested and rejected spans with the following query in OCI Monitoring for the oci_apm namespace:
2323

@@ -35,7 +35,7 @@ Optionally, an APM domain can be configured to adjust the trace data and metrics
3535
If it's decided to move from a free to a paid APM domain, it's possible to export and import all domain configurations to facilitate the move (click [here](https://docs.oracle.com/en-us/iaas/application-performance-monitoring/doc/configure-apm-domain-export-import.html) for more).
3636
 
3737

38-
### 2.2 Data sources
38+
### Data sources
3939

4040
A data source is any component made to collect data from applications for the sake of monitoring. It's important to clarify the programming languages, application servers, and frameworks used by the application environment to determine what data sources can be used for the APM domain. OCI APM provides Java and .NET agents for back-end monitoring out-of-the-box. These back-end agents are also able to automatically inject the browser agent as JavaScript for front-end monitroring. Click [here](https://docs.oracle.com/en-us/iaas/application-performance-monitoring/doc/configure-application-performance-monitoring-data-sources.html) for more about the deployment and configuration of these out-of-the-box data sources. Click [here](https://mosemp.us.oracle.com/epmos/faces/DocumentDisplay?id=2759709.1) to see what kinds of application environments they support.
4141

@@ -66,13 +66,15 @@ Data source configurations either serve to modify collected data or the amount o
6666
* **OpenTelemetry tracers**. Review any available documentation for any selected 3rd party tracer. As mentioned previously in section 2.1, you can set an enrichment rule in the APM domain to convert OpenTelemetry semantic conventions to OCI APM naming conventions. This is recommended when using a non-Oracle tracer.
6767
 
6868

69-
### 2.3 Availability Monitors
69+
### Availability Monitors
7070

7171
OCI APM can be used in two ways:
7272

7373
* Reactively monitor the application by reacting to problems when they occur during real user sessions.
7474
* Proactively monitor the application by creating an availability monitor which tests core features and user flows. The monitor can trigger a notification about critical issues without requiring them to occur in real user sessions first.
7575

76+
![APM Availability Monitoring](../images/apm_availability_monitoring.png)
77+
7678
An availability monitor consists of two components:
7779

7880
* **Monitor**. The monitor itself is a synthetic test consisting of one to multiple steps to confirm application performance in different ways. Common examples are single page loads or Selenium-scripts performing full application sessions with synthetic users. Please see [here](https://docs.oracle.com/en-us/iaas/application-performance-monitoring/doc/create-monitor.html) for more about different monitor types.
@@ -86,7 +88,7 @@ It's recommended to create availability monitors which regularly test key featur
8688
* Which vantage points should be used? This is mainly a matter of convenience vs. networking. When possible, it´s recommended to use Oracle-managed vantage points for the sake of convenience. However, no matter where the availability monitors run, the vantage point both needs to be able to reach the APM domain as well as the application itself. If it´s not feasible to connect to or resolve an application URL to an IP address from a Oracle-managed vantage point, a customer-managed vantage can work as an alternative.
8789
 
8890

89-
### 2.4 Alarms
91+
### Alarms
9092

9193
There are a lot of different metrics provided by OCI APM and a lot of different alarm definitions that can be made from them. Please see [here](https://docs.oracle.com/en-us/iaas/application-performance-monitoring/doc/application-performance-monitoring-metrics.html) for more about all available metrics in OCI APM. Please see [here](https://docs.oracle.com/en-us/iaas/Content/Monitoring/Tasks/managingalarms.htm) for more about creating alarm definitions in OCI.
9294

Loading
257 KB
Loading

0 commit comments

Comments
 (0)