|
1 | | -# Extend and contribute |
| 1 | +# Extend and contribute |
2 | 2 |
|
3 | | -This section contains information on how to extend or contribute to our various products. |
| 3 | +You can extend and build on the Elastic Platform in several ways. Whether you need to get data into Elasticsearch, add new functionality, edit the documentation, or build a custom application, here is an overview of the primary development paths to help you choose the right one for your project. |
4 | 4 |
|
5 | | -## Contributing to Elastic documentation |
| 5 | +There are two main approaches to extending Elastic: creating standardized Integrations for data ingestion or building custom solutions by developing directly against our REST APIs. |
| 6 | + |
| 7 | +## Path 1: Create an Elastic Integration |
| 8 | + |
| 9 | +If your primary goal is to bring a new data source into the Elastic Stack in a standardized, reusable way, building an Elastic Integration is the best path. Integrations are pre-packaged assets that make it simple for users to collect and process data from a specific service or platform. |
| 10 | + |
| 11 | +This approach is ideal for shipping data, logs, metrics, and traces. By building an integration, you contribute to the ever-growing ecosystem that both you and the community can benefit from. |
| 12 | + |
| 13 | +* Integrations are built on a consistent framework, providing users with a turnkey experience, including dashboards, visualizations, and alerts. |
| 14 | +* **`elastic-package`** is a command-line tool that is your primary interface for creating, testing, and packaging your integration. It scaffolds the entire project structure, letting you focus on the logic for data collection. |
| 15 | +* Your integration will run on the Elastic Agent, our single, unified agent for data shipping. |
| 16 | + |
| 17 | +**When to choose this path** |
6 | 18 |
|
7 | | -You can contribute to the Elastic documentation in several ways. |
| 19 | +* You want to ingest data from a new data source, like a database, API, or log file. |
| 20 | +* You want to provide a standardized, out-of-the-box experience for other users. |
| 21 | +* You need to process and structure data according to the Elastic Common Schema (ECS). |
8 | 22 |
|
9 | | -Refer to [Contribute to Elastic documentation](./contribute/index.md) for an overview. |
| 23 | +**Ready to start?** Head over to the [Create an Integration](integrations://extend/index.md) guide. |
10 | 24 |
|
11 | | -## Contributing to Elastic Projects |
| 25 | +## Path 2: Develop against the REST APIs |
12 | 26 |
|
13 | | -You can contribute to various projects, including: |
| 27 | +For complete control and custom development, you can interact directly with Elastic's REST APIs. This path is perfect for building custom applications, automating complex workflows, and integrating Elastic into your existing infrastructure in a bespoke way. For example, you can programmatically manage your cluster, run complex queries, manage security settings, and interact with Kibana. |
14 | 28 |
|
15 | | -- [Kibana](kibana://extend/index.md): Enhance our data visualization platform by contributing to Kibana. |
16 | | -- [Logstash](logstash://extend/index.md): Help us improve the data processing pipeline with your contributions to Logstash. |
17 | | -- [Beats](beats://extend/index.md): Add new features or beats to our lightweight data shippers. |
| 29 | +* The APIs provide direct access to the core capabilities of Elasticsearch and Kibana. If you can do it in the UI, you can automate it with the API. |
| 30 | +* Elastic provides and supports official [clients](/reference/elasticsearch-clients/index.md) for popular languages like Java, Go, .NET, PHP, Python, Ruby, and JavaScript. These clients simplify interacting with the API, handling requests, and processing responses. |
| 31 | +* The APIs are secured using role-based access control (RBAC). You can create API keys or use bearer tokens with fine-grained permissions to ensure your interactions are safe. |
18 | 32 |
|
19 | | -## Creating Integrations |
| 33 | +### Elastic APIs at a glance |
20 | 34 |
|
21 | | -Extend the capabilities of Elastic by creating integrations that connect Elastic products with other tools and systems. Visit our [Integrations Guide](integrations://extend/index.md) to get started. |
| 35 | +* Use the Elasticsearch APIs to: |
22 | 36 |
|
23 | | -## Elasticsearch Plugins |
| 37 | + * Create, read, update, and delete documents. |
| 38 | + * Perform everything from simple keyword searches to complex analytical aggregations. |
| 39 | + * Monitor cluster health, manage nodes, and configure settings. |
| 40 | + * Manage users, roles, and API keys. |
24 | 41 |
|
25 | | -Develop custom plugins to add new functionalities to Elasticsearch. Check out our [Elasticsearch Plugins Development Guide](elasticsearch://extend/index.md) for detailed instructions and best practices. |
| 42 | +* Use the Kibana APIs to programmatically control the Kibana front-end and its objects: |
| 43 | + |
| 44 | + * Create and manage dashboards, visualizations, and saved searches. |
| 45 | + * Automate the organization of content within Kibana. |
| 46 | + * Create and manage rules for detecting conditions within your data. |
| 47 | + |
| 48 | +**When to choose this path** |
| 49 | + |
| 50 | +* You are building a custom application that uses Elasticsearch as its backend. |
| 51 | +* You need to automate administrative tasks, such as creating users or managing index lifecycle policies. |
| 52 | +* You are integrating Elastic's search and analytics capabilities into another platform. |
| 53 | + |
| 54 | +Ready to get started? Explore the [Elastic API Reference]({{apis}}). |
| 55 | + |
| 56 | +## Contributing to Elastic documentation |
26 | 57 |
|
| 58 | +You can contribute to the Elastic documentation in several ways. Refer to [Contribute to Elastic documentation](./contribute/index.md) for an overview. |
0 commit comments