Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
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
2 changes: 1 addition & 1 deletion src/cloud/architecture/scaled-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ project-id@server-id:~$

The log locations vary slightly depending on the node. For example, a database log, such as the **MySQL error log**, is available on a core node (`/var/log/mysql/mysql-error.log`), but it is not available on a web node.

Each Pro plan account includes the [New Relic Logs service][nri], which automatically connects with log data from the application to provide dynamic log management. Aggregated log data from all nodes displays in the New Relic Logs UI so you can troubleshoot performance issues on specific nodes from a single dashboard.
Each Pro plan account includes the [New Relic Logs service][nri], which automatically connects with log data from the application to provide dynamic log management. Aggregated log data from all nodes displays in the New Relic Logs application so that you can troubleshoot performance issues on specific nodes from a single dashboard.

<!-- Link definitions -->
[Core tier scaling]: {{ site.baseurl }}/common/images/cloud/scaling-core.png
Expand Down
8 changes: 4 additions & 4 deletions src/cloud/cdn/cloud-vcl-custom-snippets.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Custom VCL snippets—generated, compiled, and transmitted to all Fastly caches

Fastly supports two types of custom VCL snippets:

- [Regular snippets](https://docs.fastly.com/guides/vcl-snippets/using-regular-vcl-snippets)—Custom regular VCL snippets are dependent on a specific VCL version. You can create, modify, and deploy regular VCL snippets from the Magento Admin UI or the Fastly API.
- [Regular snippets](https://docs.fastly.com/en/guides/about-vcl-snippets)—Custom regular VCL snippets are dependent on a specific VCL version. You can create, modify, and deploy regular VCL snippets from the Magento Admin UI or the Fastly API.

- [Dynamic snippets](https://docs.fastly.com/guides/vcl-snippets/using-dynamic-vcl-snippets)—VCL snippets created using the Fastly API. You can modify and deploy dynamic snippets without having to update the Fastly VCL version for your service.

Expand Down Expand Up @@ -77,7 +77,7 @@ The following table provides details about key data for custom VCL snippets. Fo
| `type` | Specifies a location for inserting the generated snippet, such as init (above subroutines) and recv (within subroutines). See Fastly VCL snippet object values for information on these values. See the Fastly [VCL snippets](https://docs.fastly.com/api/config#api-section-snippet) reference.
| `content` | The snippet of VCL code to run. Fastly does not support all VCL language features, and it also provides extensions with custom functionality. See the [Fastly VCL programming reference](https://docs.fastly.com/vcl/reference/) for information about supported VCL code features.
| `priority` | Numeric value from `1` to `100` that specifies when the custom VCL snippet code runs. Snippets with lower priority values run first. If not specified, the `priority` value defaults to `100`.<br><br> Any custom VCL snippet with a priority value of `5` runs immediately, which is best for VCL code that implements request routing (block and allow lists and redirects). Priority `100` is best for overriding default VCL snippet code. <br><br>All [default VCL snippets]({{ site.baseurl }}/cloud/cdn/configure-fastly.html#upload-vcl-snippets) included in the Magento-Fastly module have `priority=50`.<br>- Assign a high priority like `100` to run custom VCL code after all other VCL functions and override the default VCL code.
| `dynamic` | Indicates if this is a [regular snippet](https://docs.fastly.com/vcl/vcl-snippets/using-dynamic-vcl-snippets/) which is included in the versioned VCL for the Fastly service configuration, or a [dynamic snippet](https://docs.fastly.com/vcl/vcl-snippets/using-dynamic-vcl-snippets/) which can be modified and deployed without requiring a new VCL version.
| `dynamic` | Indicates if this is a [regular snippet](https://docs.fastly.com/en/guides/about-vcl-snippets) which is included in the versioned VCL for the Fastly service configuration, or a [dynamic snippet](https://docs.fastly.com/vcl/vcl-snippets/using-dynamic-vcl-snippets/) which can be modified and deployed without requiring a new VCL version.
| `active` | Indicates if the snippet or version is activated and in use. Returns `true` or `false`. Make note of the version number for an active snippet. Use this to clone the version.

## Manage custom VCL snippets from the Magento Admin UI
Expand All @@ -90,7 +90,7 @@ The *Custom VCL snippets* view shows only the snippets added through the Magento

See the following examples that show how to create and manage custom VCL snippets from the Magento Admin UI:

- [Custom VCL for IP allowlist]({{ site.baseurl }}/cloud/cdn/fastly-vcl-whitelist.html)
- [Custom VCL for IP allowlist]({{ site.baseurl }}/cloud/cdn/fastly-vcl-allowlist.html)
- [Block referral spam]({{ site.baseurl }}/cloud/cdn/fastly-vcl-badreferer.html)

## Manage custom VCL snippets using the API
Expand Down Expand Up @@ -215,7 +215,7 @@ The values include:

- `name`—Name for the VCL snippet.

- `dynamic`—Indicates if this is a [regular snippet](https://docs.fastly.com/guides/vcl-snippets/using-regular-vcl-snippets) or a [dynamic snippet](https://docs.fastly.com/guides/vcl-snippets/using-dynamic-vcl-snippets).
- `dynamic`—Indicates if this is a [regular snippet](https://docs.fastly.com/en/guides/about-vcl-snippets) or a [dynamic snippet](https://docs.fastly.com/guides/vcl-snippets/using-dynamic-vcl-snippets).

- `type`—Specifies the location for inserting the generated snippet, such as `init` (above subroutines) and `recv` (within subroutines). See [Fastly VCL snippet object values](https://docs.fastly.com/api/config#snippet) for information on these values.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ functional_areas:
- Cloud
- Setup
- Security
redirect_from:
- /cloud/configure/fastly-vcl-whitelist.html
- /cloud/cdn/fastly-vcl-whitelist.html
---

You can use a Fastly Edge ACL list in combination with a custom VCL code snippet to filter incoming requests and allow access by IP address. The ACL list specifies the IP addresses to allow.
Expand Down
26 changes: 12 additions & 14 deletions src/cloud/project/log-locations.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,32 @@
---
group: cloud-guide
title: View logs
title: View and manage logs
functional_areas:
- Cloud
- Configuration
redirect_from:
- /cloud/trouble/environments-logs.html
---
Logs are useful for troubleshooting problems related to {{site.data.var.ece}} [build and deploy hooks][hook].

{:.bs-callout-info}
Magento-specific logs are in the `<magento-root-dir>/var/` directory. See [Magento Logging][configlog] in the _Configuration guide_.
Logs for {{site.data.var.ece}} projects are useful for troubleshooting problems related to {{site.data.var.ece}} [build and deploy hooks][hook], cloud services, and the Magento application.

{:.bs-callout-tip}
When you configure your Cloud environment, you can [set up log-based Slack and email notifications][slacklog] for build and deploy actions.

## Viewing logs

There are three ways to view logs: file system, project web UI, `magento-cloud` CLI.
You can view the logs from the file system, the project web UI, and the `magento-cloud` CLI.

- **Log directories**—The `/var/log` system directory contains logs for all environments. The `var/log/` Magento directory contains app-specific logs unique to a particular environment. You must use an SSH connection to access logs in a remote server environment. These directories are not shared between nodes in a cluster. In Pro Production and Staging environments, you must check the logs on each node.
- **File system**—The `/var/log` system directory contains logs for all environments. The `var/log/` Magento directory contains app-specific logs unique to a particular environment. You must use an SSH connection to access logs in a remote server environment. These directories are not shared between nodes in a cluster. In Pro Production and Staging environments, you must check the logs on each node.

- **Project web UI**—You can see build and post-deploy log information in the environment _messages_ list.

- **Magento Cloud CLI**—You can view logs using the `magento-cloud log` command.

### Aggregated log data
## Manage log data

On Pro Production and Staging environments, you can review and analyze aggregated data from all {{ site.data.var.ece }} logs using the New Relic Logs service. See [New Relic services][].
On Pro Production and Staging environments, use the New Relic Logs application integrated with your project to manage aggregated log data from all logs associated with your {{ site.data.var.ece }} project.

The New Relic Logs application provides a centralized log management dashboard to troubleshoot and monitor {{site.data.var.ece}} Production and Staging environments. The dashboard also provides access to log data for Fastly CDN, Image Optimization, and Web application firewall (WAF) services. See [New Relic services][].

### Log command

You use the `magento-cloud log` command to quickly view a specific log. If you do not specify a log name, you can choose a log from the response list.
When you are logged into your {{ site.data.var.ece }} project, you can use the `magento-cloud log` CLI command to quickly view a specific log from the command line. If you do not specify a log name, you can choose a log from the response list.

```bash
magento-cloud log
Expand Down Expand Up @@ -78,6 +73,9 @@ Re-deploying environment project-integration-ID
[2019-01-03 19:44:32] NOTICE: Post-deploy is complete.
```

{:.bs-callout-tip}
When you configure your Cloud environment, you can set up [log-based Slack and email notifications][slacklog] for build and deploy actions.

### Error logs

Error and warning messages generated during the deployment process are written to both the `var/log/cloud.log` and the `var/log/cloud.error.log` files. The Cloud error log file contains only errors and warnings from the latest deployment. An empty file indicates a successful deployment with no errors.
Expand Down
8 changes: 6 additions & 2 deletions src/cloud/project/new-relic.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The aggregated data includes information from the following logs:
As soon as your project is connected to New Relic, you can use the New Relic Logs service to complete tasks like the following:

- Use [New Relic queries][New Relic query syntax for logs] to search aggregated log data
- Visualize log data through the New Relic UI
- Visualize log data through the New Relic Logs application
- Create custom charts, dashboards, and alerts
- Troubleshoot performance issues from a single dashboard

Expand Down Expand Up @@ -221,7 +221,10 @@ To use the New Relic Logs application:

1. On the _APM applications page_, select **Logs** from the navigation menu.

![Cloud project APM menu select Logs page]({{ site.baseurl }}/common/images/cloud/cloud-newrelic-dashboard-basic.png){:width="650px"}
![Cloud project APM menu select Logs page]({{ site.baseurl }}/common/images/cloud/cloud-newrelic-dashboard-logs-access.png){:width="650px"}

{:.bs-callout-tip}
You can also access the New Relic Logs application from the New Relic ONE home page. See [New Relic ONE core UI components][New Relic One UI].

1. To review infrastructure log data for cloud services, enter the query string `has: "ident"` in the _Find logs where_ field. Then, click **Query logs**.

Expand Down Expand Up @@ -351,6 +354,7 @@ See [Alerts concepts and workflow] in the New Relic documentation for more detai
[New Relic account]: #manage-your-new-relic-account
[New Relic APM]: https://docs.newrelic.com/docs/apm/new-relic-apm/getting-started/introduction-new-relic-apm
[New Relic APM Overview]: https://docs.newrelic.com/docs/apm/applications-menu/monitoring/apm-overview-page-view-transaction-apdex-usage-data
[New Relic ONE UI]: https://docs.newrelic.com/docs/new-relic-one/use-new-relic-one/get-started/new-relic-one-core-ui-components
[New Relic for application performance management (APM)]: https://docs.newrelic.com/docs/apm/new-relic-apm/getting-started/introduction-new-relic-apm
[New Relic Help Center]: https://newrelic.com/
[New Relic Logs]: https://docs.newrelic.com/docs/logs/new-relic-logs/get-started/introduction-new-relic-logs
Expand Down
2 changes: 1 addition & 1 deletion src/cloud/project/project-conf-files_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ The following table lists the services used in {{site.data.var.ece}} and their v
{:.error-table}
Service | Magento 2.4 |Magento 2.3 | Magento 2.2
--------- | ------------- |-------------| ------------
`elasticsearch` | 7.4.x, 7.5.x, 7.6.x, 7.7.x | **Magento version 2.3.5 and later**— 5.2, 6.5, 7.2, 7.5<br>**Magento version 2.3.1 to 2.3.4**— 6.5<br>**Magento version 2.3.0**— 2.4, 5.2 | **Magento version 2.2.8 and later**— 5.2, 6.5 <br>**Magento version 2.2.0 to 2.2.7**— 5.2
`elasticsearch` | 7.5.x, 7.6.x, 7.7.x | **Magento version 2.3.5 and later**— 5.2, 6.5, 7.2, 7.5<br>**Magento version 2.3.1 to 2.3.4**— 6.5<br>**Magento version 2.3.0**— 2.4, 5.2 | **Magento version 2.2.8 and later**— 5.2, 6.5 <br>**Magento version 2.2.0 to 2.2.7**— 5.2
`mariadb` | 10.2, 10.3, 10.4 | **Magento version 2.3.0 to 2.3.5**–10.1 to 10.2<br> | 10.1 to 10.2
`nginx` | | 1.9 | 1.9
`node` | | 6, 8, 10, 11 | 6, 8, 10, 11
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/guides/v2.3/config-guide/bootstrap/mage-profiler.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Magento profiling enables you to:

You can use a built-in profiler with Magento to perform tasks such as analyzing performance. The nature of profiling depends on the analytical tools you use. We support multiple formats, including HTML. When you enable the profiler, a `var/profiler.flag` file generates indicating the profiler is enabled and configurations. When disabled, this file is deleted.

- Display dependency graphs on a Magento page. A *dependency graph* is a list of object dependencies and all of their all their dependencies, and all the dependencies for those dependencies, and so on.
- Display dependency graphs on a Magento page. A *dependency graph* is a list of object dependencies and all of their dependencies, and all the dependencies for those dependencies, and so on.

You should be particularly interested in the list of *unused dependencies*, which are objects that were created because they were requested in some constructor, but were never used (that is, none of their methods were called). As a result, processor time and memory spent to create these dependencies are wasted.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To ensure the stability of your customizations and prevent upgrades from overwri
@font-path: '@{baseDir}fonts/<path_to_font_file>',
@font-weight: <font_weight>,
@font-style: <font_style>
@font-display: <auto|block|fallback|option|swap>
@font-display: <auto|block|fallback|optional|swap>
);
```

Expand Down
3 changes: 3 additions & 0 deletions src/guides/v2.4/security/security-txt.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ group: configuration-guide
title: Security.txt
functional_areas:
- Configuration
contributor_name: Kalpesh Mehta from Corra
contributor_link: https://partners.magento.com/portal/details/partner/id/70

---

When security vulnerabilities are discovered by researchers, proper reporting channels are often lacking. As a result, some vulnerabilities are not reported. The purpose of the `security.txt` [file format](https://tools.ietf.org/html/draft-foudil-securitytxt-09) is to give security researchers the information they need to report their findings.
Expand Down