Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WFCORE-2953] Add documentation for the socket-handler on the logging subsystem. #11406

Merged
merged 2 commits into from
Aug 14, 2018

Conversation

jamezp
Copy link
Member

@jamezp jamezp commented Jul 9, 2018

This is documentation for WFCORE-2953 WildFly Core PR and the proposal PR.

The first commit just cleans up the handler documentation a bit as well as remove the common_attributes document in favor of using the maven plugin configuration.

@kabir kabir added the core-upgrade-needed PR requires a wildfly-core change to be merged and integrated first label Jul 12, 2018
* <<named-formatter,#named-formatter>>
* <<target,#target>>
A `custom-handler` allows you to define any {oracle-javadoc}/java/util/logging/Handler.html[handler] as a handler that
can be assigned to a logger or aa <<async-handler,`async-handler`>>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably a typo "aa async-handler" -> "an async-handler" ?

==== Attributes
The `max-backup-index` works differently on this handler than the
<<size-rotating-file-handler,`size-rotating-file-handler`>>. The date suffix of the file to be rotated must be the
same as the current expected suffix. For example with a suffix patter of `yyyy-MM` and a `rotate-size` of `10m` the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: "suffix patter" -> "suffix pattern"

@nziakova
Copy link
Contributor

The docs does not mention SSL/TLS TCP which is listed in the analysis doc as requirement. Maybe the docs could show an example of usage similar to the UDP one, WDYT?

@jamezp
Copy link
Member Author

jamezp commented Jul 24, 2018

@nziakova For SSL/TLS the idea was the socket-binding configuration should cover that. I did make a link to the docs. Would that be enough or do you think we need an example there as well? My only simple objection is we'd probably want to do both an Elytron and legacy example. I just don't want that part of the docs going stale.

@nziakova
Copy link
Contributor

@jamezp The link should be enough, but there's no SSL/TLS example at Admin_Guide#socket-binding-groups. Maybe we only need the Elytron example for community docs?

@nziakova
Copy link
Contributor

@jamezp I cannot find any SSL setting on the socket-binding, how do you configure it?

@jamezp
Copy link
Member Author

jamezp commented Jul 27, 2018

@nziakova You're correct. I'll have to rework that as I misunderstood how it works. Sorry about the confusion.

@jamezp jamezp added the hold PR should not be merged for some reason. label Jul 27, 2018
@nziakova
Copy link
Contributor

@jamezp Ah, ok. I wasn't sure if I didn't miss anything. So should the SSL config be part of the logging subsystem? In that case we will need the SSL example in the docs, I think.

@jamezp
Copy link
Member Author

jamezp commented Jul 30, 2018

@nziakova Yes. I'm going to add an ssl-context attribute which can reference an Elytron SSL Context. I'm also adding a test for it, but that's currently where I'm stuck because it isn't working yet :) Hopefully I'll get it done today though.

I'll also update the documentation and the analysis doc. Thanks for catching this! I made some really bad assumptions.

@nziakova
Copy link
Contributor

@jamezp It's new to me too, I was just searching for the correct config to test it. Thanks for taking care of it!

@jamezp jamezp removed the hold PR should not be merged for some reason. label Jul 31, 2018
@jamezp
Copy link
Member Author

jamezp commented Jul 31, 2018

Docs have been updated with an SSL example.

@kabir kabir added the Feature-Docs PR documents a new feature coming via WildFly Core label Aug 8, 2018
@jamezp jamezp removed the core-upgrade-needed PR requires a wildfly-core change to be merged and integrated first label Aug 13, 2018
@kabir kabir merged commit 8614939 into wildfly:master Aug 14, 2018
@jamezp jamezp deleted the WFCORE-2953 branch February 6, 2019 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature-Docs PR documents a new feature coming via WildFly Core
Projects
None yet
3 participants