Skip to content

Commit a185ee8

Browse files
semantic-release-botsemantic-release-bot
committed
chore(release): 0.2.1 [skip ci]
## [0.2.1](v0.2.0...v0.2.1) (2022-05-28) ### Bug Fixes * **ci:** Do not use npm plugin ([a556415](a556415)) * **ci:** Fix conditional step ([cbd0dc2](cbd0dc2)) * **ci:** Fix path to CHANGELOG.md ([e2234ad](e2234ad)) * **ci:** Fix upload of assets to GitHub ([9e3cf8c](9e3cf8c)) * **ci:** Force release step out of dry run mode ([0101b48](0101b48)) * **ci:** Include packaged released in GitHub release(s) ([2f5732b](2f5732b)) * **ci:** Pass GITHUB_TOKEN to Docker containers ([6204af5](6204af5)) * **ci:** Remove duplicated 'install' command ([717e727](717e727)) * **ci:** Run release step inside Docker ([df145cf](df145cf)) * **ci:** Use git and github plugins ([d852d98](d852d98))
1 parent a556415 commit a185ee8

File tree

8 files changed

+364
-0
lines changed

8 files changed

+364
-0
lines changed

‎dist/CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
## 0.1.0 (Unreleased)
4+
5+
Initial release.

‎dist/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎dist/README.md‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Splunk Data Source Plugin for Grafana
2+
3+
![Splunk Data Source for Grafana](https://github.com/efcasado/grafana-plugin-splunk-datasource/actions/workflows/ci.yml/badge.svg?branch=main)
4+
[!["Buy Me A Coffee"](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee)](https://www.buymeacoffee.com/efcasado)
5+
6+
7+
## What is Splunk Data Source Plugin for Grafana?
8+
9+
Splunk Data Source Plugin for Grafana is a Grafana (data source) plugin that
10+
allows you to pull Splunk data into your Grafana dashboards. Or, in other words,
11+
it is a Grafana plugin that allows you to query Splunk directly from Grafana.
12+
13+
14+
### Installation
15+
16+
1. Download the latest version of the plugin
17+
18+
```bash
19+
wget https://github.com/efcasado/grafana-plugin-splunk-datasource/releases/download/v0.1.0/efcasado-splunk-datasource-0.1.0.zip
20+
```
21+
22+
2. Unzip it in your Grafana's installation plugin directory (eg. `/var/lib/grafana/plugins`)
23+
24+
```bash
25+
unzip efcasado-splunk-datasource-0.1.0.zip -d YOUR_PLUGIN_DIR/efcasado-splunk-datasource
26+
```
27+
28+
29+
### Configuration
30+
31+
The preferred way to configure Splunk Data Source Plugin for Grafana is using
32+
a [provisioning file](https://grafana.com/docs/grafana/latest/administration/provisioning/).
33+
You can use the provisioning script [included in this repository](https://github.com/efcasado/grafana-plugin-splunk-datasource/blob/main/provisioning/datasources/splunk-datasource.yml)
34+
as source of inspiration. However, the plugin can also be manually configured
35+
by an administrator from Grafana's UI `Configuration --> Datasources --> Add data source`.
36+
37+
38+
| Field | Description |
39+
|:--------:|--------------------------------------------------------------|
40+
| Protocol | `http` or `https` |
41+
| Endpoint | (eg. `localhost`) |
42+
| Port | TCP port used by your Splunk instance to expose its REST API |
43+
| Username | Splunk user |
44+
| Password | Splunk password |
45+
| Token | Basic auth token |
46+
47+
48+
### Graphing Splunk Results in Grafana
49+
50+
For Grafana to be able to graph the data pulled from your Splunk instance, it
51+
requieres a `Time` field, which should be formatted as `%Y-%m-%dT%H:%M:%S.000Z`.
52+
An easy way to achieve this is including the following command to your
53+
Splunk queries: `eval _time=strftime(_time, "%Y-%m-%dT%H:%M:%S.000Z") | rename _time AS Time`.
54+
55+
<img width="100%" alt="graphing-splunk-results-in-grafana" src="https://user-images.githubusercontent.com/603610/170813937-2d7f03c6-d0d7-49b8-83a7-3c1b186fd0f7.png">
56+
57+
```
58+
index=_internal *
59+
| timechart span=1m count
60+
| eval _time=strftime(_time, "%Y-%m-%dT%H:%M:%S.000Z")
61+
| rename _time AS Time
62+
```
63+
64+
65+
### Getting Started
66+
67+
1. Build the project
68+
69+
```bash
70+
make build
71+
```
72+
73+
2. Spin up the test environment
74+
75+
```bash
76+
make up
77+
```
78+
79+
3. Point your browser to [localhost:3000](http://localhost:3000)
80+
81+
82+
## License
83+
84+
> The MIT License (MIT)
85+
>
86+
> Copyright (c) 2022, Enrique Fernandez
87+
>
88+
> Permission is hereby granted, free of charge, to any person obtaining a copy
89+
> of this software and associated documentation files (the "Software"), to deal
90+
> in the Software without restriction, including without limitation the rights
91+
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
92+
> copies of the Software, and to permit persons to whom the Software is
93+
> furnished to do so, subject to the following conditions:
94+
>
95+
> The above copyright notice and this permission notice shall be included in
96+
> all copies or substantial portions of the Software.
97+
>
98+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
99+
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
100+
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
101+
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
102+
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
103+
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
104+
> THE SOFTWARE.

‎dist/img/logo.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎dist/module.js‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/module.js.LICENSE.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

‎dist/module.js.map‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/plugin.json‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/grafana/grafana/master/docs/sources/developers/plugins/plugin.schema.json",
3+
"type": "datasource",
4+
"name": "splunk-datasource",
5+
"id": "efcasado-splunk-datasource",
6+
"routes": [
7+
{
8+
"path": "splunk-datasource",
9+
"url": "{{ .JsonData.protocol }}://admin:thisisasecret@{{ .JsonData.endpoint }}:{{ .JsonData.port }}",
10+
"headers": [
11+
{
12+
"name": "Authorization",
13+
"content": "Basic {{ .SecureJsonData.token }}"
14+
}
15+
]
16+
}
17+
],
18+
"metrics": true,
19+
"info": {
20+
"description": "",
21+
"author": {
22+
"name": "efcasado",
23+
"url": ""
24+
},
25+
"keywords": [],
26+
"logos": {
27+
"small": "img/logo.svg",
28+
"large": "img/logo.svg"
29+
},
30+
"links": [
31+
{
32+
"name": "Website",
33+
"url": "https://github.com/efcasado/grafana-plugin-splunk-datasource"
34+
},
35+
{
36+
"name": "License",
37+
"url": "https://github.com/efcasado/grafana-plugin-splunk-datasource/blob/main/LICENSE"
38+
}
39+
],
40+
"screenshots": [],
41+
"version": "0.1.1",
42+
"updated": "2022-05-28"
43+
},
44+
"dependencies": {
45+
"grafanaDependency": ">=7.0.0",
46+
"plugins": []
47+
}
48+
}

0 commit comments

Comments
 (0)