Postfix rewrite #16724
Postfix rewrite #16724
Conversation
bradleycamacho
added
content
|
Hi @bradleycamacho 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes). If you add any more commits, you can comment |
✅ Deploy Preview for docs-website-netlify ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
||
| * Our [guided install](https://one.newrelic.com/nr1-core?state=4f81feab-35f7-e97e-9903-52510f8542bd) is a CLI tool that inspects your system and installs the infrastructure agent alongside the application monitoring agent that best works for your system. To learn more about how our guided install works, check out our [Guided install overview](/docs/infrastructure/host-integrations/installation/new-relic-guided-install-overview). | ||
| * If you'd rather install our infrastructure agent manually, you can follow a tutorial for manual installation for [Linux](/docs/infrastructure/install-infrastructure-agent/linux-installation/install-infrastructure-monitoring-agent-linux), [Windows](/docs/infrastructure/install-infrastructure-agent/windows-installation/install-infrastructure-monitoring-agent-windows/), or [macOS](/docs/infrastructure/install-infrastructure-agent/macos-installation/install-infrastructure-monitoring-agent-macos/). | ||
| ## Set up the Postfix integration |
There was a problem hiding this comment.
Intro reads a little awkward but it's not letting edit in GH:
Our Postfix integration consolidates mail server data into one view, so you can track how many emails are sent, bounced, or deferred in a given time period. Our Postfix integration uses our infrastructure monitoring agent, and gives you a pre-built dashboard with your most important Postfix metrics like email delivery process, mail queue, and message overview.
There was a problem hiding this comment.
idk edit this so its smoother or just take it. "performance metrics" for a mail server felt a little stilted
| ## Export Postfix data [#export] | ||
|
|
||
| Use `pflogsumm` to export your Postfix metrics. `Pflogsumm` is a log analyzer for Postfix agent and designed to provide an overview of Postfix activity, with just enough detail to give the administrator a "heads up" for potential trouble spots. | ||
| Use `pflogsumm` to export your Postfix metrics. `Pflogsumm` is a log analyzer for Postfix agent and designed to provide an overview of Postfix activity, with enough detail to give the administrator a "heads up" for potential trouble spots. |
There was a problem hiding this comment.
| Use `pflogsumm` to export your Postfix metrics. `Pflogsumm` is a log analyzer for Postfix agent and designed to provide an overview of Postfix activity, with enough detail to give the administrator a "heads up" for potential trouble spots. | |
| Export your Postfix metrics with `pflogsumm`. The Postfix agent uses`pflogsumm` as a log analyzer, which translates into metric data about your Postfix activity. This gives you enough detail to anticipate potential incidences with email administration. |
| title={<>Download <InlineCode>pflogsumm</InlineCode></>} | ||
| > | ||
| 1. Run the following command to use `pflogsumm`: | ||
| 1. Run the following commands to download and extract `pflogsumm`: |
There was a problem hiding this comment.
Do they need to be in a particular directory/folder/whatever?
| ```shell | ||
| tar xvf pflogsumm-1.1.3.tar.gz | ||
| ``` | ||
|
|
||
| 3. Navigate to the `pflogsumm` folder. | ||
| 2. Navigate to the `pflogsumm` folder. |
There was a problem hiding this comment.
| 2. Navigate to the `pflogsumm` folder. | |
| 2. Go to the `pflogsumm` folder. |
| ## Configure NRI-Flex for Postfix | ||
|
|
||
| Flex comes bundled with the New Relic infrastructure agent. To create a flex configuration file follow these steps: | ||
| Flex, our application-agnostic monitoring tool, comes bundled with the New Relic infrastructure agent. To create a flex configuration file to report Postfix data follow these steps: |
There was a problem hiding this comment.
do we have an app-gnostic tool 😏
| ## Configure NRI-Flex for Postfix | ||
|
|
||
| Flex comes bundled with the New Relic infrastructure agent. To create a flex configuration file follow these steps: | ||
| Flex, our application-agnostic monitoring tool, comes bundled with the New Relic infrastructure agent. To create a flex configuration file to report Postfix data follow these steps: |
There was a problem hiding this comment.
| Flex, our application-agnostic monitoring tool, comes bundled with the New Relic infrastructure agent. To create a flex configuration file to report Postfix data follow these steps: | |
| Flex, our application-agnostic monitoring tool, comes bundled with the New Relic infrastructure agent. Follow these steps to create a flex configuration file for your Postfix data: |
| * `COMMAND`: This contains the command which is used to print metrics on the terminal. | ||
|
|
||
| Once your configuration file is updated, it will look like below: | ||
| 2. Update the file `postfix-flex-config.yml`. You can use the configuration sample below, or create your own using the following pattern: |
There was a problem hiding this comment.
We should reorganize this step. Let me give it a stab
| * `COMMAND`: This contains the command which is used to print metrics on the terminal. | ||
|
|
||
| Once your configuration file is updated, it will look like below: | ||
| 2. Update the file `postfix-flex-config.yml`. You can use the configuration sample below, or create your own using the following pattern: |
There was a problem hiding this comment.
| 2. Update the file `postfix-flex-config.yml`. You can use the configuration sample below, or create your own using the following pattern: | |
| 2. Update the file `postfix-flex-config.yml`. We recommend you work off our configuration sample below: | |
| EXAMPLE HERE | |
| If you'd prefer to make your own, then make sure that your yaml file follows this pattern: | |
| ```yml | |
| - event_type: A New Relic database table that you can query using NRQL. | |
| commands: The command used to print metrics on the terminal. |
There was a problem hiding this comment.
although frankly i think this is even too verbose. customers can just refer to our provided snippet but the "make your own instructions" should prob just be AFTER the example with the explanations for the value they need to put in
|
|
||
| On Linux machines, your log file named `logging.yml` should be present in this path: | ||
| 1. Create a file named `logging.yml` in the infrastrucutre agent directory: |
There was a problem hiding this comment.
same comment as sonarqube. what value do customers get by forwarding logs? how does opting out of log forwarding degrade their data?
There was a problem hiding this comment.
I'll add a quick intro sentence, but I don't think we should delve into explaining the big "whys" and "hows" of logs. I think it is outside the scope of an intro experience, and getting users an experience with as much data as possible is the priority.
| * `COMMAND`: This contains the command which is used to print metrics on the terminal. | ||
|
|
||
| Once your configuration file is updated, it will look like below: | ||
| 2. Update the file `postfix-flex-config.yml`. You can use the configuration sample below, or create your own using the following pattern: |
| ## Monitor your application | ||
|
|
||
| You can choose our pre-built dashboard template named `Postfix` to monitor your Postfix application metrics. Follow these steps to use our pre-built dashboard template: | ||
| Follow these steps to use our pre-built dashboard template to easily view your Postfix data: | ||
|
|
||
| 1. Go to <DoNotTranslate>**[one.newrelic.com](https://one.newrelic.com/)**</DoNotTranslate> and click on <DoNotTranslate>**+ Add data**</DoNotTranslate>. |
There was a problem hiding this comment.
i'm just noticing this, but should these substeps be nested? i would go back and check sonarqube to make sure they are as well
| @@ -376,28 +356,27 @@ You can choose our pre-built dashboard template named `Postfix` to monitor your | |||
|
|
|||
| Your Postfix dashboard is considered a custom dashboard and can be found in the <DoNotTranslate>**Dashboards**</DoNotTranslate> UI. For docs on using and editing dashboards, see [our dashboard docs](/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards). | |||
There was a problem hiding this comment.
I would spruce this step up and make it a 'View your data' pattern per other OHIs. I also don't think we should err on the side of linking out to docs in branching oHI steps bc it gets tedious + might deter customers from getting any value from it
|
|
||
| View your latest message record's status | ||
| ```sql |
| ```sql | ||
| SELECT * | ||
| FROM PostfixGrandTotals | ||
| ``` | ||
|
|
||
|
|
||
| Here is a NRQL query to view your per-hour message records: | ||
|
|
||
| View your per-hour message records | ||
| ```sql |
There was a problem hiding this comment.
Left some copy-level edits on your Postfix rewrite + made some suggestions on structure. At minimum, I would give this a quick copy edit on some language + indeent code snippets/nested substeps as needed.
Don't forget to update 'Monitor your blahblahblah' into a 'View your d ata' step per other OHIs
No description provided.