Skip to content

Commit 2b18ced

Browse files
CAWilson94CAWilson94
committed
nlp hello world package
1 parent 8477eb1 commit 2b18ced

File tree

8 files changed

+341
-0
lines changed

8 files changed

+341
-0
lines changed

‎packages/entityanalytics_nlp/LICENSE.txt‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
Elastic License 2.0
2+
3+
URL: https://www.elastic.co/licensing/elastic-license
4+
5+
## Acceptance
6+
7+
By using the software, you agree to all of the terms and conditions below.
8+
9+
## Copyright License
10+
11+
The licensor grants you a non-exclusive, royalty-free, worldwide,
12+
non-sublicensable, non-transferable license to use, copy, distribute, make
13+
available, and prepare derivative works of the software, in each case subject to
14+
the limitations and conditions below.
15+
16+
## Limitations
17+
18+
You may not provide the software to third parties as a hosted or managed
19+
service, where the service provides users with access to any substantial set of
20+
the features or functionality of the software.
21+
22+
You may not move, change, disable, or circumvent the license key functionality
23+
in the software, and you may not remove or obscure any functionality in the
24+
software that is protected by the license key.
25+
26+
You may not alter, remove, or obscure any licensing, copyright, or other notices
27+
of the licensor in the software. Any use of the licensor’s trademarks is subject
28+
to applicable law.
29+
30+
## Patents
31+
32+
The licensor grants you a license, under any patent claims the licensor can
33+
license, or becomes able to license, to make, have made, use, sell, offer for
34+
sale, import and have imported the software, in each case subject to the
35+
limitations and conditions in this license. This license does not cover any
36+
patent claims that you cause to be infringed by modifications or additions to
37+
the software. If you or your company make any written claim that the software
38+
infringes or contributes to infringement of any patent, your patent license for
39+
the software granted under these terms ends immediately. If your company makes
40+
such a claim, your patent license ends immediately for work on behalf of your
41+
company.
42+
43+
## Notices
44+
45+
You must ensure that anyone who gets a copy of any part of the software from you
46+
also gets a copy of these terms.
47+
48+
If you modify the software, you must include in any modified copies of the
49+
software prominent notices stating that you have modified the software.
50+
51+
## No Other Rights
52+
53+
These terms do not imply any licenses other than those expressly granted in
54+
these terms.
55+
56+
## Termination
57+
58+
If you use the software in violation of these terms, such use is not licensed,
59+
and your licenses will automatically terminate. If the licensor provides you
60+
with a notice of your violation, and you cease all violation of this license no
61+
later than 30 days after you receive that notice, your licenses will be
62+
reinstated retroactively. However, if you violate these terms after such
63+
reinstatement, any additional violation of these terms will cause your licenses
64+
to terminate automatically and permanently.
65+
66+
## No Liability
67+
68+
*As far as the law allows, the software comes as is, without any warranty or
69+
condition, and the licensor will not be liable to you for any damages arising
70+
out of these terms or the use or nature of the software, under any kind of
71+
legal claim.*
72+
73+
## Definitions
74+
75+
The **licensor** is the entity offering these terms, and the **software** is the
76+
software the licensor makes available under these terms, including any portion
77+
of it.
78+
79+
**you** refers to the individual or entity agreeing to these terms.
80+
81+
**your company** is any legal entity, sole proprietorship, or other kind of
82+
organization that you work for, plus all organizations that have control over,
83+
are under the control of, or are under common control with that
84+
organization. **control** means ownership of substantially all the assets of an
85+
entity, or the power to direct its management and policies by vote, contract, or
86+
otherwise. Control can be direct or indirect.
87+
88+
**your licenses** are all the licenses granted to you for the software under
89+
these terms.
90+
91+
**use** means anything you do with the software requiring one of your licenses.
92+
93+
**trademark** means trademarks, service marks, and similar rights.

‎packages/entityanalytics_nlp/_dev/build/docs/README.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
{{- generatedHeader }}
2+
{{/*
3+
This template can be used as a starting point for writing documentation for your new integration. For each section, fill in the details
4+
described in the comments.
5+
6+
Find more detailed documentation guidelines in https://www.elastic.co/docs/extend/integrations/documentation-guidelines
7+
*/}}
8+
# entityanalytics_nlp Integration for Elastic
9+
10+
## Overview
11+
{{/* Complete this section with a short summary of what data this integration collects and what use cases it enables */}}
12+
The entityanalytics_nlp integration for Elastic enables collection of ...
13+
This integration facilitates ...
14+
15+
### Compatibility
16+
{{/* Complete this section with information on what 3rd party software or hardware versions this integration is compatible with */}}
17+
This integration is compatible with ...
18+
19+
### How it works
20+
{{/* Add a high level overview on how this integration works. For example, does it collect data from API calls or recieving data from a network or file.*/}}
21+
22+
## What data does this integration collect?
23+
{{/* Complete this section with information on what types of data the integration collects, and link to reference documentation if available */}}
24+
The {{.Manifest.Title}} integration collects log messages of the following types:
25+
* ...
26+
27+
### Supported use cases
28+
{{/* Add details on the use cases that can be enabled by using this integration. Explain why a user would want to install and use this integration. */}}
29+
30+
## What do I need to use this integration?
31+
{{/* List any vendor-specific prerequisites needed before starting to install the integration. */}}
32+
33+
## How do I deploy this integration?
34+
35+
### Agent-based deployment
36+
37+
Elastic Agent must be installed. For more details, check the Elastic Agent [installation instructions](docs-content://reference/fleet/install-elastic-agents.md). You can install only one Elastic Agent per host.
38+
39+
Elastic Agent is required to stream data from the syslog or log file receiver and ship the data to Elastic, where the events will then be processed via the integration's ingest pipelines.
40+
41+
{{/* If agentless is available for this integration, we'll want to include that here as well.
42+
### Agentless deployment
43+
44+
Agentless deployments are only supported in Elastic Serverless and Elastic Cloud environments. Agentless deployments provide a means to ingest data while avoiding the orchestration, management, and maintenance needs associated with standard ingest infrastructure. Using an agentless deployment makes manual agent deployment unnecessary, allowing you to focus on your data instead of the agent that collects it.
45+
46+
For more information, refer to [Agentless integrations](https://www.elastic.co/guide/en/serverless/current/security-agentless-integrations.html) and [Agentless integrations FAQ](https://www.elastic.co/guide/en/serverless/current/agentless-integration-troubleshooting.html)
47+
*/}}
48+
49+
### Onboard / configure
50+
{{/* List the steps that will need to be followed in order to completely set up a working inte completely set up a working integration.
51+
For integrations that support multiple input types, be sure to add steps for all inputs.
52+
*/}}
53+
54+
### Validation
55+
{{/* How can the user test whether the integration is working? Including example commands or test files if applicable */}}
56+
57+
## Troubleshooting
58+
59+
For help with Elastic ingest tools, check [Common problems](https://www.elastic.co/docs/troubleshoot/ingest/fleet/common-problems).
60+
{{/*
61+
Add any vendor specific troubleshooting here.
62+
63+
Are there common issues or “gotchas” for deploying this integration? If so, how can they be resolved?
64+
If applicable, links to the third-party software’s troubleshooting documentation.
65+
*/}}
66+
67+
## Scaling
68+
69+
For more information on architectures that can be used for scaling this integration, check the [Ingest Architectures](https://www.elastic.co/docs/manage-data/ingest/ingest-reference-architectures) documentation.
70+
{{/* Add any vendor specific scaling information here */}}
71+
72+
## Reference
73+
{{/* Repeat for each data stream of the current type
74+
### {Data stream name}
75+
76+
The `{data stream name}` data stream provides events from {source} of the following types: {list types}.
77+
78+
For each data_stream_name, include an optional summary of the datastream, the exported fields reference table and the sample event.
79+
80+
The fields template function will be replaced by a generated list of all fields from the `fields/` directory of the data stream when building the integration.
81+
82+
#### {data stream name} fields
83+
84+
To include a generated list of fields from the `fields/` directory, uncomment and use:
85+
{{ fields "data_stream_name" }}
86+
87+
The event template function will be replace by a sample event, taken from `sample_event.json`, when building this integration.
88+
89+
To include a sample event from `sample_event.json`, uncomment and use:
90+
{{ event "data_stream_name" }}
91+
92+
*/}}
93+
94+
### Inputs used
95+
{{/* All inputs used by this package will be automatically listed here. */}}
96+
{{ inputDocs }}
97+
98+
### API usage
99+
{{/* For integrations that use APIs to collect data, document all the APIs that are used, and link to relevent information */}}
100+
These APIs are used with this integration:
101+
* ...

‎packages/entityanalytics_nlp/changelog.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# newer versions go on top
2+
- version: "0.0.1"
3+
changes:
4+
- description: Initial draft of the package
5+
type: enhancement
6+
link: https://github.com/elastic/integrations/pull/1 # FIXME Replace with the real PR link

‎packages/entityanalytics_nlp/docs/README.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
{{- generatedHeader }}
2+
{{/*
3+
This template can be used as a starting point for writing documentation for your new integration. For each section, fill in the details
4+
described in the comments.
5+
6+
Find more detailed documentation guidelines in https://www.elastic.co/docs/extend/integrations/documentation-guidelines
7+
*/}}
8+
# entityanalytics_nlp Integration for Elastic
9+
10+
## Overview
11+
{{/* Complete this section with a short summary of what data this integration collects and what use cases it enables */}}
12+
The entityanalytics_nlp integration for Elastic enables collection of ...
13+
This integration facilitates ...
14+
15+
### Compatibility
16+
{{/* Complete this section with information on what 3rd party software or hardware versions this integration is compatible with */}}
17+
This integration is compatible with ...
18+
19+
### How it works
20+
{{/* Add a high level overview on how this integration works. For example, does it collect data from API calls or recieving data from a network or file.*/}}
21+
22+
## What data does this integration collect?
23+
{{/* Complete this section with information on what types of data the integration collects, and link to reference documentation if available */}}
24+
The {{.Manifest.Title}} integration collects log messages of the following types:
25+
* ...
26+
27+
### Supported use cases
28+
{{/* Add details on the use cases that can be enabled by using this integration. Explain why a user would want to install and use this integration. */}}
29+
30+
## What do I need to use this integration?
31+
{{/* List any vendor-specific prerequisites needed before starting to install the integration. */}}
32+
33+
## How do I deploy this integration?
34+
35+
### Agent-based deployment
36+
37+
Elastic Agent must be installed. For more details, check the Elastic Agent [installation instructions](docs-content://reference/fleet/install-elastic-agents.md). You can install only one Elastic Agent per host.
38+
39+
Elastic Agent is required to stream data from the syslog or log file receiver and ship the data to Elastic, where the events will then be processed via the integration's ingest pipelines.
40+
41+
{{/* If agentless is available for this integration, we'll want to include that here as well.
42+
### Agentless deployment
43+
44+
Agentless deployments are only supported in Elastic Serverless and Elastic Cloud environments. Agentless deployments provide a means to ingest data while avoiding the orchestration, management, and maintenance needs associated with standard ingest infrastructure. Using an agentless deployment makes manual agent deployment unnecessary, allowing you to focus on your data instead of the agent that collects it.
45+
46+
For more information, refer to [Agentless integrations](https://www.elastic.co/guide/en/serverless/current/security-agentless-integrations.html) and [Agentless integrations FAQ](https://www.elastic.co/guide/en/serverless/current/agentless-integration-troubleshooting.html)
47+
*/}}
48+
49+
### Onboard / configure
50+
{{/* List the steps that will need to be followed in order to completely set up a working inte completely set up a working integration.
51+
For integrations that support multiple input types, be sure to add steps for all inputs.
52+
*/}}
53+
54+
### Validation
55+
{{/* How can the user test whether the integration is working? Including example commands or test files if applicable */}}
56+
57+
## Troubleshooting
58+
59+
For help with Elastic ingest tools, check [Common problems](https://www.elastic.co/docs/troubleshoot/ingest/fleet/common-problems).
60+
{{/*
61+
Add any vendor specific troubleshooting here.
62+
63+
Are there common issues or “gotchas” for deploying this integration? If so, how can they be resolved?
64+
If applicable, links to the third-party software’s troubleshooting documentation.
65+
*/}}
66+
67+
## Scaling
68+
69+
For more information on architectures that can be used for scaling this integration, check the [Ingest Architectures](https://www.elastic.co/docs/manage-data/ingest/ingest-reference-architectures) documentation.
70+
{{/* Add any vendor specific scaling information here */}}
71+
72+
## Reference
73+
{{/* Repeat for each data stream of the current type
74+
### {Data stream name}
75+
76+
The `{data stream name}` data stream provides events from {source} of the following types: {list types}.
77+
78+
For each data_stream_name, include an optional summary of the datastream, the exported fields reference table and the sample event.
79+
80+
The fields template function will be replaced by a generated list of all fields from the `fields/` directory of the data stream when building the integration.
81+
82+
#### {data stream name} fields
83+
84+
To include a generated list of fields from the `fields/` directory, uncomment and use:
85+
{{ fields "data_stream_name" }}
86+
87+
The event template function will be replace by a sample event, taken from `sample_event.json`, when building this integration.
88+
89+
To include a sample event from `sample_event.json`, uncomment and use:
90+
{{ event "data_stream_name" }}
91+
92+
*/}}
93+
94+
### Inputs used
95+
{{/* All inputs used by this package will be automatically listed here. */}}
96+
{{ inputDocs }}
97+
98+
### API usage
99+
{{/* For integrations that use APIs to collect data, document all the APIs that are used, and link to relevent information */}}
100+
These APIs are used with this integration:
101+
* ...

‎packages/entityanalytics_nlp/img/sample-logo.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎packages/entityanalytics_nlp/img/sample-screenshot.png‎

18.4 KB
Loading

‎packages/entityanalytics_nlp/manifest.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
format_version: 3.5.0
2+
name: entityanalytics_nlp
3+
title: "entityanalytics_nlp"
4+
version: 0.0.1
5+
source:
6+
license: "Elastic-2.0"
7+
description: "Entity Analytics NLP Integration"
8+
type: integration
9+
categories:
10+
- custom
11+
conditions:
12+
kibana:
13+
version: "^9.1.3"
14+
elastic:
15+
subscription: "enterprise"
16+
screenshots:
17+
- src: /img/sample-screenshot.png
18+
title: Sample screenshot
19+
size: 600x600
20+
type: image/png
21+
icons:
22+
- src: /img/sample-logo.svg
23+
title: Sample logo
24+
size: 32x32
25+
type: image/svg+xml
26+
policy_templates:
27+
- name: sample
28+
title: Sample logs
29+
description: Collect sample logs
30+
inputs:
31+
- type: logfile
32+
title: Collect sample logs from instances
33+
description: Collecting sample logs
34+
owner:
35+
github: elastic/integrations
36+
type: elastic

‎packages/entityanalytics_nlp/sample_event.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"description": "This is an example sample-event for entityanalytics_nlp. Replace it with a real sample event. Hint: If system tests exist, running `elastic-package test system --generate` will generate this file."
3+
}

0 commit comments

Comments
 (0)