doc: add usage & bump version

kunyan · Dec 11, 2020 · 3717680 · 3717680
1 parent 52823c3
commit 3717680
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -24,16 +24,45 @@ logger.send({
   message: "Hello World";
 });
 
+// Send with metadata
+logger.send("Hello World", {
+  source: 'my-app',
+  sourcetype: '_raw'
+})
+
 
 // Send Raw
 logger.sendRaw("Hello World");
 
 ```
 
+#### Options
+
+| Name       | Description                                                                                            | Type                | Default                    |
+| ---------- | ------------------------------------------------------------------------------------------------------ | ------------------- | -------------------------- |
+| `token`    | The Splunk HEC token, required                                                                         | `String`            | null                       |
+| `protocol` | The Splunk HEC protocol                                                                                | `http` \|\| `https` | `https`                    |
+| `host`     | The Splunk HEC host                                                                                    | `String`            | `localhost`                |
+| `port`     | The Splunk HEC port                                                                                    | `Number`            | `8088`                     |
+| `path`     | The Splunk HEC path                                                                                    | `String`            | `/services/collector`      |
+| `source`   | Then event source                                                                                      | `String`            | `log2splunk`               |
+| `index`    | The event index                                                                                        | `String`            | Extend your HEC token info |
+| `https`    | The https config, more info in [https options](https://github.com/sindresorhus/got#advanced-https-api) | `Object`            | null                       |
+
+#### Metadata
+
+| Name         | Description                                                                                                                                                                                                                                                                                                                                                                | Type                                                  | Default     |
+| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------- |
+| `time`       | The event time in epoch time, in the format `\<sec\>`.`\<ms\>`. For example, `1433188255.500` indicates 1433188255 seconds and 500 milliseconds after epoch, or Monday, June 1, 2015, at 7:50:55 PM GMT.                                                                                                                                                                   | `Number`                                              | now         |
+| `host`       | The `host` value to assign to the event data. This is typically the hostname of the client from which you're sending data.                                                                                                                                                                                                                                                 | `String`                                              |             |
+| `source`     | The `source` value to assign to the event data. For example, if you're sending data from an app you're developing, you could set this key to the name of the app.                                                                                                                                                                                                          | `String`                                              |             |
+| `sourcetype` | The `sourcetype` value to assign to the event data.                                                                                                                                                                                                                                                                                                                        | `String`                                              | `httpevent` |
+| `index`      | The name of the index by which the event data is to be indexed. The index you specify here must be within the list of allowed indexes if the token has the `indexes` parameter set.                                                                                                                                                                                        | `String`                                              |             |
+| `fields`     | (Not applicable to raw data.) Specifies a JSON object that contains explicit custom fields to be defined at index time. Requests containing the `"fields"` property must be sent to the `/collector/event` endpoint, or they will not be indexed. For more information, see [Indexed field extractions](http://docs.splunk.com/Documentation/Splunk/8.1.0/Data/IFXandHEC). | `String` or `Object<String, String \| Array<String>>` |             |
+
 #### Async/Await
 
 ```js
-//
 (async () => {
   await logger.send('Hello async/await');
 })();

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "log2splunk",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Log to Splunk",
   "main": "./dist/index.js",
   "types": "./@types/index.d.ts",

diff --git a/src/index.ts b/src/index.ts
@@ -37,10 +37,10 @@ const defaultOptions: ILog2SplunkOptions = {
   host: 'localhost',
   port: 8088,
   path: '/services/collector',
+  source: pkgJSON.name,
 };
 
 const defaultMetadata: IMetadata = {
-  source: pkgJSON.name,
   sourcetype: 'httpevent',
 };