Skip to content

Commit 7b6aea2

Browse files
committed
Merge remote-tracking branch 'origin/AC-15682' into phpunit12_upgrade_and_compatible_with_phpunit10
2 parents d5cd90b + 59c30ab commit 7b6aea2

File tree

1 file changed

+79
-3
lines changed

1 file changed

+79
-3
lines changed

app/code/Magento/NewRelicReporting/README.md

Lines changed: 79 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,87 @@ Extension developers can interact with the Magento_NewRelicReporting module. For
3535

3636
### Console commands
3737

38-
The Magento_NewRelicReporting provides console commands:
38+
**Syntax:**
39+
```bash
40+
bin/magento newrelic:create:deploy-marker <message> [<changelog>] [<user>] [<revision>] [options]
41+
```
3942

40-
- `bin/magento newrelic:create:deploy-marker <message> <change_log> [<user>]` - check the deploy queue for entries and create an appropriate deploy marker
43+
**Arguments:**
4144

42-
[Learn more about command's parameters](https://experienceleague.adobe.com/docs/commerce-operations/reference/magento-open-source.html#newreliccreatedeploy-marker).
45+
- `<message>` - Required: Deployment description or title
46+
- `[<changelog>]` - Optional: Summary of changes in this deployment
47+
- `[<user>]` - Optional: User who performed the deployment (defaults to system user)
48+
- `[<revision>]` - Optional: Version or revision identifier
49+
50+
**Options (NerdGraph enhanced):**
51+
52+
- `--commit="<hash>"` - Git commit hash for this deployment
53+
- `--deep-link="<url>"` - Deep link to deployment details
54+
- `--group-id="<id>"` - Group ID for organizing deployments
55+
56+
**Examples:**
57+
58+
Basic usage (works with both APIs):
59+
60+
```bash
61+
bin/magento newrelic:create:deploy-marker "Release v1.2.0" "Bug fixes and performance improvements"
62+
```
63+
64+
With user and revision:
65+
66+
```bash
67+
bin/magento newrelic:create:deploy-marker "Release v1.2.0" "Bug fixes and performance improvements" "dev-team" "v1.2.0"
68+
```
69+
70+
Enhanced usage with NerdGraph options:
71+
72+
```bash
73+
bin/magento newrelic:create:deploy-marker "Production Deploy" "Updates and new features" "ops-user" "v1.2.0" \
74+
--commit="abc123def456" \
75+
--deep-link="https://github.com/<company>/<project>/releases/tag/v1.2.0" \
76+
--group-id="production"
77+
```
78+
79+
80+
[Learn more about command's parameters](https://experienceleague.adobe.com/en/docs/commerce-operations/tools/cli-reference/commerce-on-premises#newreliccreatedeploy-marker).
81+
82+
### Configuration
83+
84+
The module supports both v2 REST API and the modern NerdGraph GraphQL API for deployment tracking.
85+
86+
#### Admin configuration
87+
88+
Navigate to Stores > Configuration > General > New Relic Reporting, enable New Relic Integration, and select your Deployment API Mode (v2_rest for legacy REST or nerdgraph for modern GraphQL).
89+
90+
#### NerdGraph configuration (recommended)
91+
92+
When **Deployment API Mode** is set to **nerdgraph**, the following options are available:
93+
94+
- **New Relic API URL (NerdGraph)**:
95+
- US: `https://api.newrelic.com/graphql`
96+
- EU: `https://api.eu.newrelic.com/graphql`
97+
- **Entity GUID (NerdGraph)**: Your application's entity GUID
98+
- **New Relic API Key**: Create a user key, see the [New Relic API Keys](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/) documentation
99+
100+
#### V2 REST configuration
101+
102+
When **Deployment API Mode** is set to **v2_rest**, configure:
103+
104+
- **New Relic API URL (v2 REST)**: API endpoint
105+
- **New Relic Application ID**: Can be found in the APM URL after "/applications/"
106+
- **New Relic API Key**: Your REST API key
107+
108+
### NerdGraph features
109+
110+
When using NerdGraph mode, the module provides:
111+
112+
#### Enhanced Metadata Support
113+
114+
- **Commit hash**: Git commit tracking
115+
- **Deep links**: Links to deployment details
116+
- **Group ID**: Environment/team organization
117+
- **Automatic timestamps**: Precise deployment timing
118+
- **Version tracking**: Automatic or manual version assignment
43119

44120
### Cron options
45121

0 commit comments

Comments
 (0)