https://github.com/hashgraph/log4j2-hedera
Provides Log4j 2.x support for Hedera™ via an Appender that records logged events using the Hedera™ Consensus Service (HCS).
https://github.com/hashgraph/log4j2-hedera
Last synced: 5 months ago
JSON representation
Provides Log4j 2.x support for Hedera™ via an Appender that records logged events using the Hedera™ Consensus Service (HCS).
- Host: GitHub
- URL: https://github.com/hashgraph/log4j2-hedera
- Owner: hashgraph
- License: apache-2.0
- Created: 2020-03-27T17:12:15.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-16T09:25:27.000Z (over 3 years ago)
- Last Synced: 2024-09-10T20:22:04.216Z (almost 2 years ago)
- Language: Java
- Homepage:
- Size: 38.1 KB
- Stars: 5
- Watchers: 9
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# log4j2-hedera
Provides [Log4j 2.x] support for Hedera™ via an Appender that records logged events using the Hedera™ Consensus Service (HCS).
[Log4j 2.x]: https://logging.apache.org/log4j/2.x/
## Install
##### Gradle
```groovy
implementation 'com.hedera.hashgraph:log4j2:0.1.0'
```
##### Maven
```xml
com.hedera.hashgraph
log4j2
0.1.0
```
## Usage
* Create the directory `src/main/resources` in your project
* Add the file `log4j2.xml` to the resources directory you just made in your project. An example configuration file is in this repo.
* Add HederaAppender under Appenders in the log4j2.xml like this:
```
...
...
...
```
* Import the log4j packages `LogManager` and `Logger` like this:
```
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
```
* Instantiate the logger like this:
```
final static Logger logger = LogManager.getLogger(App.class);
```
* Log things like this:
```
logger.debug("This is a debug log: " + message);
logger.info("This is an info log : " + message);
logger.warn("This is a warning log : " + message);
logger.error("This is an error log : " + message);
logger.fatal("This is a fatal log : " + message);
```
## Configuration
All configuration for the Appender is done in `log4j2.xml`.
To log things under the level of error, make sure to change the line `` to ``,\
``, or ``.
Make sure you remember to change the values for each of the `` attributes in your project! The ones provided in the example won't work as is!
#### Attributes
Note: All attribute values should be Strings.
##### Required:
```name```\
The name of the appender
```topicId```\
The ID of your topic in the form of `shard.realm.num`
```operatorId```\
Your Hedera Account ID in the form of `shard.realm.num`
```operatorKey```\
Your Hedera Account Ed25519 Private Key
```networkName```\
The name of the network you wish to log to, either `testnet` or `mainnet`
##### Optional:
```submitKey```\
If your HCS topic was created with a submit key, you must provide an Ed25519 Private Key\
(your submit key) to sign each message with
## Contributing to this Project
We welcome participation from all developers!
For instructions on how to contribute to this repo, please
review the [Contributing Guide](CONTRIBUTING.md).
## License
Licensed under Apache License,
Version 2.0 – see [LICENSE](LICENSE) in this repo
or [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)