https://github.com/elmahio/elmah.io.elasticsearch
Elmah.Io.ElasticSearch is an Elasticsearch storage backend for ELMAH.
https://github.com/elmahio/elmah.io.elasticsearch
elasticsearch elasticsearch-storage-backend elmah elmah-io
Last synced: 8 months ago
JSON representation
Elmah.Io.ElasticSearch is an Elasticsearch storage backend for ELMAH.
- Host: GitHub
- URL: https://github.com/elmahio/elmah.io.elasticsearch
- Owner: elmahio
- License: apache-2.0
- Created: 2013-08-18T19:58:59.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T07:59:30.000Z (about 3 years ago)
- Last Synced: 2025-04-13T00:43:42.768Z (8 months ago)
- Topics: elasticsearch, elasticsearch-storage-backend, elmah, elmah-io
- Language: C#
- Homepage: https://elmah.io
- Size: 3.92 MB
- Stars: 23
- Watchers: 8
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: license.txt
Awesome Lists containing this project
README
# Elmah.Io.ElasticSearch
Elmah.Io.ElasticSearch is an Elasticsearch storage backend for ELMAH.
[](https://ci.appveyor.com/project/jayhilden/elmah-io-elasticsearch/branch/master)
[](https://www.nuget.org/packages/Elmah.ElasticSearch)
# Release 3.0 - NEST 6 support
### [Release Notes](https://github.com/elmahio/Elmah.Io.ElasticSearch/wiki/1.3-Release-Notes)
**Note: Release 3.0 may not be compatible with ElasticSearch < 5.x and/or NEST < 6.x. If you have any trouble with that, then please install version 2.0.1.50 [here](https://www.nuget.org/packages/Elmah.ElasticSearch/2.0.1.50).**
**Note: Release 3.0 is not compatible with ElasticSearch 1.x If you are still using 1.x then please install version 1.2.0.13 [here](https://www.nuget.org/packages/Elmah.ElasticSearch/1.2.0.31).**
## Create amazing graphs and dashboards with Kibana
# QuickStart (Less than 5 minutes!)
Elmah.Io.ElasticSearch is configured like other implementations for Elmah. To get started, add the following to your web.config or app.config:
#### 1. *Before* installing, verify that your project is using .NET 4.6.1 or higher.
#### 2. Install Package
#### 3. Verify `sectionGroup name="elmah"`
When you installed this package the `app.config` or `web.config` file should have had a new sectionGroup added with the name Elmah.
```
...
```
#### 4. Connection String & `` configuration section
Add a connection string for the Elmah.ElasticSearch and a new section right below that which references that connection name.
```
```
#### 5. Try it!
##### Web Application
On a web application simply go to a URL that doesn't exist and it should log a message to elmah.
##### Console Application
The following sample code will log to Elmah:
```
static void Main(string[] args)
{
WriteElmahException(new Exception("this should log to elmah"));
Console.WriteLine("Console finished, press enter to exit");
Console.ReadLine();
}
private static void WriteElmahException(Exception ex)
{
var elmahCon = ErrorLog.GetDefault(null);
elmahCon.Log(new Error(ex));
}
```
#### 4. Examples
[Example Web Application](src/examples/WebWithExternalReferences)
[Example Console Application](src/examples/Elmah.Io.ElasticSearch.ConsoleTester)
# Configuration
The ElasticSearch connection string supports the following information:
#### 1. Specify Node URL(s)
A list of 1 to N Nodes - This is a comma separated list of nodes for your ES cluster.
Example of a single node:
```
```
Example of specifying 3 nodes:
```
```
#### 2. Specify Default index
The default index for Elmah can be specified as a static index.
In this example the index has the name "elmahIndex1"
```
```
The index can also be specified as a **rolling index**. In the example below the index uses the current day, month, and year.
```
```
#### 3. Specify a username and password for use with ElasticSearch Shield.
```
```
When using ES Shield here are the recommended settings for a user role with the name 'elmah'
```
elmah:
indices:
'elmah':
privileges: read, index, indices:admin/get, indices:admin/exists, indices:admin/mapping/put, create_index
```
The user needs to be able to check if the index exists and if it does not exist it needs to be able to create the index plus apply the mapping.
#### 4. `` configuration
```
```
In the example above you can see the following optional fields have been specified:
1. Application Name
2. Environment Name
3. Customer Name
You can see a sample web.config that has both the `` configuration and the connection string [here] (Elmah.Io.ElasticSearch.Web/Web.config)
## Retreiving raw data
To get the data from Elastic, run the following:
```
GET elmah/error/_search
{
"query": {
"match_all": {}
}
}
```
Sample Result:
```
{
"took": 4,
"timed_out": false,
"_shards": {
"total": 5,
"successful": 5,
"failed": 0
},
"hits": {
"total": 1,
"max_score": 1,
"hits": [
{
"_index": "elmah",
"_type": "error",
"_id": "AUwupDKg5dFjuaEj8ID-",
"_score": 1,
"_source": {
"errorXml": "",
"applicationName": "ElmahElasticSearchSampleWebsite",
"hostName": "VB-133",
"type": "System.Web.HttpException",
"source": "System.Web.Mvc",
"message": "The controller for path '/asdfdsaf' was not found or does not implement IController.",
"detail": "System.Web.HttpException (0x80004005): The controller for path '/asdfdsaf' was not found or does not implement IController.",
"user": "",
"@timestamp": "2015-03-18T15:47:35.0322548-05:00",
"statusCode": 404,
"webHostHtmlMessage": "",
"environmentName": "development",
"customerName": "sample customer"
}
}
]
}
}
```