Skip to content

Commit e70653c

Browse files
committed
apm-lz-addon-update
1 parent ec747ba commit e70653c

File tree

4 files changed

+162
-0
lines changed

4 files changed

+162
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# **[OCI Landing Zone Application Performance Monitoring Service](#)**
2+
## **An OCI Open LZ Addon to enable Application Performance Monitoring in your LZ**
3+
 
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.
6+
7+
|Step | Name| Link|
8+
|---|---|---|
9+
| 1 | Design Decisions | Link |
10+
| 2 | WIP | Coming Soon |
11+
| 3 | WIP| Coming Soon |
12+
| 4 | WIP | Coming Soon|
13+
 
14+
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+
28+
# License
29+
30+
Copyright (c) 2025 Oracle and/or its affiliates.
31+
32+
Licensed under the Universal Permissive License (UPL), Version 1.0.
33+
34+
See [LICENSE](/LICENSE.txt) for more details.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# **[OCI Landing Zone Application Performance Monitoring Service](#)**
2+
## **Deployment Blueprint for OCI Application Performance Monitoring**
3+
 
4+
5+
Based on the design decisions made for OCI Application Performance Monitoring (OCI APM), a basic deployment of OCI APM will look like the blueprint below:
6+
7+
![OCI APM Deployment](../images/apm_deployment.png)
8+
 
9+
10+
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.
11+
12+
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.
13+
14+
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.
15+
16+
# License
17+
18+
Copyright (c) 2025 Oracle and/or its affiliates.
19+
20+
Licensed under the Universal Permissive License (UPL), Version 1.0.
21+
22+
See [LICENSE](/LICENSE.txt) for more details.

0 commit comments

Comments
 (0)