Skip to content

Commit

Permalink
Update README.md, CONTRIBUTING.md and JMX_INTERFACE.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
ryatoa committed Sep 20, 2019
1 parent c58ff0e commit 76b2d58
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -57,7 +57,7 @@ If you set your `user.name` and `user.email` git configs, you can sign your
commit automatically with `git commit -s`.

If you fix some documentation (typos, formatting, ...) you are not required to sign-off.
It is possible to sign your commits in retrospective, [too](http://stackoverflow.com/questions/13043357/git-sign-off-previous-commits)
It is possible to sign your commits retrospectively, [too](http://stackoverflow.com/questions/13043357/git-sign-off-previous-commits)
if you forgot it the first time.

## Code of Conduct
Expand Down Expand Up @@ -117,7 +117,7 @@ a project may be further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
reported by contacting the project team at <top4j@openanswers.co.uk>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
8 changes: 6 additions & 2 deletions README.md
Expand Up @@ -13,7 +13,7 @@ The [Top4J Java Agent](/README.md#run-top4j-as-a-java-agent) is invoked via the

See [Getting Started](/README.md#getting-started) section for more details.

Top4J is part of the Open Answers [Panther](https://www.openanswers.co.uk/products/panther) suite of monitoring applications.
Top4J is an open sourced component of the Open Answers [Panther](https://www.openanswers.co.uk/products/panther) suite of monitoring applications.

Getting Started
===============
Expand Down Expand Up @@ -91,8 +91,10 @@ The Top4J Java Agent is configured via a standard [Java properties file](https:/
Build Top4J (via Maven)
-----------------------
Make sure JDK 8+ and Maven 3.x are installed on your machine, then....
```bash
git clone git@gitlab.openans.co.uk:open-answers/top4j.git
cd top4j
mvn clean package
```
Expand All @@ -105,6 +107,8 @@ Contributing
Please read [CONTRIBUTING.md](/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
For general queries, please email the project team at <top4j@openanswers.co.uk>. If you think you've found a bug or have an enhancement request, please check the Top4J [issue management database](https://github.com/OpenAnswers/top4j/issues) for existing issues before submitting [a new issue](https://github.com/OpenAnswers/top4j/issues/new).
Versioning
==========
Expand All @@ -115,7 +119,7 @@ Authors
* **Ryan Young** - *Project founder* - [Open Answers](https://github.com/OpenAnswers)
See also the list of [contributors](https://github.com/OpenAnswers/top4j/contributors) who participated in this project.
See also the list of [contributors](https://github.com/OpenAnswers/top4j/contributors) who have participated in this project.
License
=======
Expand Down
4 changes: 4 additions & 0 deletions docs/JMX_INTERFACE.md
Expand Up @@ -12,6 +12,10 @@ A complete list of Top4J MBeans and their associated attributes is documented be

**MBeanCpuTime:** The amount of CPU time in milliseconds consumed by the MBean update() operation per invocation.

**Enabled:** Boolean flag indicating whether the MBean is enabled (true) or disabled (false). Disabled MBeans will no longer receive updates via the MBean update() operation or the Top4J Java Agent stats update process. An MBean will be marked as disabled if the update() operation encounters an unexpected exception.

**FailureReason:** If the update() operation encounters an unexpected exception the failure reason will be stored within the FailureReason MBean attribute.

### Operations

**update():** Update MBean attributes with latest data.
Expand Down

0 comments on commit 76b2d58

Please sign in to comment.