Skip to content
This repository has been archived by the owner on Jun 1, 2024. It is now read-only.

ElasticsearchJsonFormatter should set render message to true by default #158

Closed
1 of 2 tasks
klettier opened this issue Mar 10, 2018 · 1 comment
Closed
1 of 2 tasks

Comments

@klettier
Copy link
Contributor

Does this issue relate to a new feature or an existing bug?

  • Bug
  • New Feature

What version of Serilog.Sinks.Elasticsearch is affected? Please list the related NuGet package.

  • All

What is the target framework and operating system? See target frameworks & net standard matrix.

  • All

Please describe the current behavior?

When I'm calling WriteTo.Elasticsearch without providing any CustomFormatter in ElasticsearchSinkOptions it will create a formatter with property renderMessage set to true see here.

If I'm providing my own instance of ElasticsearchJsonFormatter I have to be aware of that behavior to avoid losing my message property because the default behavior is to set renderMessage to false see here

Please describe the expected behavior?

I think we should be consistent here and set renderMessage to true by default in the constructor of ElasticsearchJsonFormatter

klettier added a commit to klettier/serilog-sinks-elasticsearch that referenced this issue Mar 10, 2018
@mivano
Copy link
Contributor

mivano commented Apr 21, 2018

Merged

@mivano mivano closed this as completed Apr 21, 2018
mivano added a commit that referenced this issue Apr 21, 2018
* Explain use of `AutoRegisterTemplateVersion` in the README (#157)

It took me a while to figure out that the reason the sink failed to start with a somewhat cryptic "Failed to execute" error was that, while I had updated all libraries to ES6-compatibile versions, I had not set the  `AutoRegisterTemplateVersion` option and so the template sent was not ES6-compatible (it used "string").

This PR explains this snag in the readme.

For a future PR, would it make sense to deprecate the manual option and automatically detect the ES version when attempting to register a template? It can be fetched by a GET request at the root URL, which returns:

```    {
      "name" : "8hV7EYy",
      "cluster_name" : "docker-cluster",
      "cluster_uuid" : "bC1bTjVuTiyWoaprIIZIIw",
      "version" : {
        "number" : "6.2.1",
        "build_hash" : "7299dc3",
        "build_date" : "2018-02-07T19:34:26.990113Z",
        "build_snapshot" : false,
        "lucene_version" : "7.2.1",
        "minimum_wire_compatibility_version" : "5.6.0",
        "minimum_index_compatibility_version" : "5.0.0"
      },
      "tagline" : "You Know, for Search"
    }
```

* Added some explanation

See #165

* Render message by default #158, Could disable MessageTemplate #159 + Tests (#160)

* Updated readme

* Expose interface-typed options via appsettings (#162)

* Expose interface-typed settings via appsettings

* Amend readme to show changes for json appsettings as well

* Updated changelog
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants