Skip to content

teragrep/cfe_16

Repository files navigation

HTTP Event Capture, HEC, to Syslog

License

AGPLv3 with additional permissions granted in the license.

Compiling

mvn clean verify package

Running

Configuration

Default properties location is at config/application.properties

Supported protocols are RELP, TCP, UDP.

syslog.server.host=127.0.0.1
syslog.server.port=601
syslog.server.protocol=RELP
max.channels=1000000
max.ack.value=1000000
max.ack.age=20000
max.session.age=30000
poll.time=300000
config.poll.time=5000
spring.devtools.add-properties=false
server.print.times=true
Note
It is advised to use RELP and rsyslog for reception for data durability.

Execution

java -jar target/cfe_16.jar

Testing

Performance

Performance test client execution

Test client is located in class com.teragrep.cfe_16.TestClient

TestClient parameters:

  1. cfe_16 server hostname

  2. cfe_16 server port

  3. number of threads

  4. number of loops per thread

Connect to Spring embedded Tomcat at localhost:8080, and instantiate one thread doing the HTTP requests.

java -classpath target/classes com.teragrep.cfe_16.TestClient localhost 8080 1 4
Note
It is advised to warm up the JVM before reporting the results by running a warm-up loop with intended amount of threads and 50 loops per thread.

Contributing

You can involve yourself with our project by opening an issue or submitting a pull request.

Contribution requirements:

  1. All changes must be accompanied by a new or changed test. If you think testing is not required in your pull request, include a sufficient explanation as why you think so.

  2. Security checks must pass

  3. Pull requests must align with the principles and values of extreme programming.

  4. Pull requests must follow the principles of Object Thinking and Elegant Objects (EO).

Read more in our Contributing Guideline.

Contributor License Agreement

Contributors must sign Teragrep Contributor License Agreement before a pull request is accepted to organization’s repositories.

You need to submit the CLA only once. After submitting the CLA you can contribute to all Teragrep’s repositories.