adds host and path to structured log formats

[nhomble]

Proposed change for #915

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.

[whiskeysierra]

Thanks for your pull request! 📣

Looks good so far. Just one thing to add:
This change affects both, the JsonHttpLogFormatter and the SplunkHttpLogFormatter. The docs for both should be adjusted accordingly:

• https://github.com/zalando/logbook#json
• https://github.com/zalando/logbook#splunk

Another idea, while we're at it: What about scheme, port and query? If we break down the request uri into its components, why not apply it all the way?

[nhomble]

Sorry for missing the docs, I'll definitely update.

I also agree that it makes sense to add all of the components. One question, should we be consistent with the prepareHeaders/prepareBody pattern and ignore port when optional is empty and ignore query when query is empty?

[whiskeysierra]

Good question. I already thought about it. I guess absent would be more consistent with the existing features. But null values or defaults could be easier to use on the log analytics site of things.

[nhomble]

I think it would be reasonable to put null as a default port. And then if users want to remap to some numeric default they can do that in their query.
I'm also thinking for query, it would be nice to parse the map out of the string and insert into content similar to headers. Beyond making searching easier, I think if we make this a utility method of HttpRequest then the QueryFilter implementation could become easier.

[nhomble]

Since the other keys are pretty straightforward, I'm thinking we tackle the query params separate from the other simpler fields (happy to follow up with another pr). I was also a little confused by the readme since it mentioned path in both the json and splunk examples. If there is another transformation happening somewhere, I could use help seeing where that happens.

[whiskeysierra]

I'm also thinking for query, it would be nice to parse the map out of the string and insert into content similar to headers. Beyond making searching easier, I think if we make this a utility method of HttpRequest then the QueryFilter implementation could become easier.

Yes, that would be nice.

Since the other keys are pretty straightforward, I'm thinking we tackle the query params separate from the other simpler fields (happy to follow up with another pr).

Sounds good.

I was also a little confused by the readme since it mentioned path in both the json and splunk examples. If there is another transformation happening somewhere, I could use help seeing where that happens.

I guess it's just out of date with the implementation. Maybe I had this in mind at some point but never implemented it.

[whiskeysierra]

I'm not an expert on splunk - maybe an empty value would be cleaner?

[whiskeysierra]

Looks like it https://community.splunk.com/t5/Splunk-Search/What-is-the-best-way-to-search-for-blank-null-fields-in-a-search/m-p/211083

[whiskeysierra]

👍

[whiskeysierra]

Thanks for your contribution! 🎉

I'll wait for your other PRs to make one big release, unless you need it faster.

[nhomble]

@whiskeysierra thanks! I think I should have bandwidth to finish our open prs and propose something for the query params.