-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updates to reflect archival status: mark project as archived in README mark project as abandoned in composer.json
- Loading branch information
Showing
3 changed files
with
55 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,5 @@ | ||
| # Contributing | ||
|
|
||
| Contributions are always welcome. Before contributing please read the | ||
| [code of conduct](./CODE_OF_CONDUCT.md) and [search the issue tracker](issues); your issue may have already been discussed or fixed in `master`. To contribute, | ||
| [fork](https://help.github.com/articles/fork-a-repo/) this repository, commit your changes, and [send a Pull Request](https://help.github.com/articles/using-pull-requests/). | ||
| As of June, 2023 the **Monolog components to enable New Relic Logs** project is archived and available for cloning only. We encourage you to experiment with it in your fork however please keep in mind that there is neither a maintainer team nor support. | ||
|
|
||
| Note that our [code of conduct](./CODE_OF_CONDUCT.md) applies to all platforms and venues related to this project; please follow it in all your interactions with the project and its participants. | ||
|
|
||
| ## Feature Requests | ||
|
|
||
| Feature requests should be submitted in the [Issue tracker](../../issues), with a description of the expected behavior & use case, where they’ll remain closed until sufficient interest, [e.g. :+1: reactions](https://help.github.com/articles/about-discussions-in-issues-and-pull-requests/), has been [shown by the community](../../issues?q=label%3A%22votes+needed%22+sort%3Areactions-%2B1-desc). | ||
| Before submitting an Issue, please search for similar ones in the | ||
| [closed issues](../../issues?q=is%3Aissue+is%3Aclosed+label%3Aenhancement). | ||
|
|
||
| ## Pull Requests | ||
|
|
||
| 1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. | ||
| 2. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). | ||
| 3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. | ||
|
|
||
| ## Contributor License Agreement | ||
|
|
||
| Keep in mind that when you submit your Pull Request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at [email protected]. | ||
|
|
||
| For more information about CLAs, please check out Alex Russell’s excellent post, | ||
| [“Why Do I Need to Sign This?”](https://infrequently.org/2008/06/why-do-i-need-to-sign-this/). | ||
| To [all contributors](https://github.com/newrelic/newrelic-monolog-logenricher-php/graphs/contributors), we thank you! Without your contribution, this project would not be what it is today. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,4 @@ | ||
| [](https://opensource.newrelic.com/oss-category/#community-plus) | ||
|
|
||
| [](https://opensource.newrelic.com/oss-category/#archived) | ||
| # Monolog components to enable New Relic logs | ||
|
|
||
| [](https://packagist.org/packages/newrelic/monolog-enricher) [](//packagist.org/packages/newrelic/monolog-enricher) [](https://circleci.com/gh/newrelic/newrelic-monolog-logenricher-php) [](https://packagist.org/packages/newrelic/monolog-enricher) | ||
|
|
@@ -8,9 +7,9 @@ This package provides the components required to integrate a PHP application | |
| using [Monolog](https://github.com/Seldaek/monolog) with | ||
| [New Relic Logs](https://newrelic.com/products/logs). | ||
|
|
||
| ## Important Notice | ||
| ## Archival Notice | ||
|
|
||
| The New Relic PHP agent (version 10.3.0 and newer) now supports Monolog log forwarding automatically and is the recommended way to capture log output from your PHP application. [Learn more about automatic log forwarding](https://docs.newrelic.com/docs/logs/logs-context/configure-logs-context-php/#automatic-logs-in-context). | ||
| As of **June, 2023** the **Monolog components to enable New Relic Logs** project is archived. The [New Relic PHP agent](https://github.com/newrelic/newrelic-php-agent) (version 10.3.0 and newer) supports Monolog 2 and Monolog 3 log forwarding automatically and is the recommended way to capture log output from your PHP application. [Learn more about automatic log forwarding](https://docs.newrelic.com/docs/logs/logs-context/configure-logs-context-php/#automatic-logs-in-context). | ||
|
|
||
| ## Installation | ||
|
|
||
|
|
@@ -191,76 +190,17 @@ More information on configuring your logging tool to send logs to New Relic | |
| Logs can be found | ||
| [within the New Relic documentation](https://docs.newrelic.com/docs/logs/new-relic-logs/enable-logs/enable-new-relic-logs). | ||
|
|
||
| ## Testing | ||
|
|
||
| ### Running unit tests | ||
|
|
||
| This project uses [PHPUnit 4](https://phpunit.de/manual/4.8/en/index.html), | ||
| which is the last PHPUnit version to support PHP 5.3. | ||
|
|
||
| You can run the test suite via Composer: | ||
|
|
||
| ```bash | ||
| composer test | ||
| ``` | ||
|
|
||
| If `phpdbg` is available, you can also generate a code coverage report while | ||
| running the test suite: | ||
|
|
||
| ```bash | ||
| composer test-coverage | ||
| ``` | ||
|
|
||
| This will write a HTML coverage report to `coverage/index.html`. | ||
|
|
||
| ### Running integration tests | ||
|
|
||
| It's also possible to run a suite of integration tests against both Monolog 1 | ||
| and 2 via Composer: | ||
|
|
||
| ```bash | ||
| composer integration | ||
| ``` | ||
|
|
||
| More information on these tests is available in the | ||
| [`tests/integration` README](tests/integration/README.md). | ||
|
|
||
| ## Support | ||
|
|
||
| Should you need assistance with New Relic products, you are in good hands with several support channels. | ||
|
|
||
| If the issue has been confirmed as a bug or is a feature request, file a GitHub issue. | ||
|
|
||
| **Support Channels** | ||
|
|
||
| * [New Relic Documentation](https://docs.newrelic.com/docs/logs/enable-log-management-new-relic/logs-context-php/configure-logs-context-php): Comprehensive guidance for using our platform | ||
| * [New Relic Community](https://discuss.newrelic.com/c/telemetry-data-platform/log-management): The best place to engage in troubleshooting questions | ||
| * [New Relic Developer](https://developer.newrelic.com/): Resources for building a custom observability applications | ||
| * [New Relic University](https://learn.newrelic.com/): A range of online training for New Relic users of every level | ||
|
|
||
|
|
||
| ## Privacy | ||
| At New Relic we take your privacy and the security of your information seriously, and are committed to protecting your information. We must emphasize the importance of not sharing personal data in public forums, and ask all users to scrub logs and diagnostic information for sensitive information, whether personal, proprietary, or otherwise. | ||
|
|
||
| We define “Personal Data” as any information relating to an identified or identifiable individual, including, for example, your name, phone number, post code or zip code, Device ID, IP address, and email address. | ||
|
|
||
| For more information, review [New Relic’s General Data Privacy Notice](https://newrelic.com/termsandconditions/privacy). | ||
|
|
||
| ## Contribute | ||
|
|
||
| We encourage your contributions to improve `newrelic-monolog-logenricher-php`! Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. | ||
|
|
||
| If you have any questions, or to execute our corporate CLA (which is required if your contribution is on behalf of a company), drop us an email at [email protected]. | ||
| As of June, 2023 the **Monolog components to enable New Relic Logs** project is archived and available for cloning only. We encourage you to experiment with it in your fork however please keep in mind that there is neither a maintainer team nor support. | ||
|
|
||
| **A note about vulnerabilities** | ||
|
|
||
| As noted in our [security policy](../../security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals. | ||
|
|
||
| If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic). | ||
|
|
||
| If you would like to contribute to this project, review [these guidelines](./CONTRIBUTING.md). | ||
|
|
||
| To [all contributors](https://github.com/newrelic/newrelic-monolog-logenricher-php/graphs/contributors), we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to [Monolog for New Relic Logs](https://opensource.newrelic.com/projects/newrelic/newrelic-monolog-logenricher-php). | ||
| To [all contributors](https://github.com/newrelic/newrelic-monolog-logenricher-php/graphs/contributors), we thank you! Without your contribution, this project would not be what it is today. | ||
|
|
||
| ### Setting up a development environment | ||
|
|
||
|
|
@@ -293,5 +233,52 @@ composer coding-standard-fix | |
| When submitting a fix, please also ensure a corresponding entry has been added | ||
| to the [changelog](CHANGELOG.md). | ||
|
|
||
| ## Testing | ||
|
|
||
| ### Running unit tests | ||
|
|
||
| This project uses [PHPUnit 4](https://phpunit.de/manual/4.8/en/index.html), | ||
| which is the last PHPUnit version to support PHP 5.3. | ||
|
|
||
| You can run the test suite via Composer: | ||
|
|
||
| ```bash | ||
| composer test | ||
| ``` | ||
|
|
||
| If `phpdbg` is available, you can also generate a code coverage report while | ||
| running the test suite: | ||
|
|
||
| ```bash | ||
| composer test-coverage | ||
| ``` | ||
|
|
||
| This will write a HTML coverage report to `coverage/index.html`. | ||
|
|
||
| ### Running integration tests | ||
|
|
||
| It's also possible to run a suite of integration tests against both Monolog 1 | ||
| and 2 via Composer: | ||
|
|
||
| ```bash | ||
| composer integration | ||
| ``` | ||
|
|
||
| More information on these tests is available in the | ||
| [`tests/integration` README](tests/integration/README.md). | ||
|
|
||
| ## Privacy | ||
| At New Relic we take your privacy and the security of your information seriously, and are committed to protecting your information. We must emphasize the importance of not sharing personal data in public forums, and ask all users to scrub logs and diagnostic information for sensitive information, whether personal, proprietary, or otherwise. | ||
|
|
||
| We define “Personal Data” as any information relating to an identified or identifiable individual, including, for example, your name, phone number, post code or zip code, Device ID, IP address, and email address. | ||
|
|
||
| For more information, review [New Relic’s General Data Privacy Notice](https://newrelic.com/termsandconditions/privacy). | ||
|
|
||
| ## License | ||
| `newrelic-monolog-logenricher-php` is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License. | ||
|
|
||
| ## Resources | ||
|
|
||
| * [New Relic Documentation](https://docs.newrelic.com/docs/logs/logs-context/configure-logs-context-php/): Comprehensive guidance for using our platform | ||
| * [New Relic Developer](https://developer.newrelic.com/): Resources for building a custom observability applications | ||
| * [New Relic University](https://learn.newrelic.com/): A range of online training for New Relic users of every level | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,7 @@ | |
| "email": "[email protected]" | ||
| } | ||
| ], | ||
| "abandoned": true, | ||
| "require": { | ||
| "php": ">=5.3.0", | ||
| "monolog/monolog": "^2" | ||
|
|
||