a661e2d084This adds advanced developer documentation for ECS tooling, which documents all steps of the generation pipeline, adds information on the ECS-OTel mapping process, adds pydoc to all functions. It also adds documentation on field re-use, subset and exclude filters. --------- Co-authored-by: Claude <noreply@anthropic.com> |
||
|---|---|---|
| .github | ||
| docs | ||
| experimental | ||
| generated | ||
| rfcs | ||
| schemas | ||
| scripts | ||
| .backportrc.json | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .mergify.yml | ||
| CHANGELOG.md | ||
| CHANGELOG.next.md | ||
| CONTRIBUTING.md | ||
| LICENSE.txt | ||
| Makefile | ||
| NOTICE.txt | ||
| otel-semconv-version | ||
| README.md | ||
| renovate.json | ||
| stages.html | ||
| USAGE.md | ||
| version | ||
Elastic Common Schema (ECS)
The Elastic Common Schema (ECS) defines a common set of fields for ingesting data into Elasticsearch. A common schema helps you correlate data from sources like logs and metrics or IT operations analytics and security analytics.
ECS Donation to OpenTelemetry
In April 2023, OpenTelemetry and Elastic made an important joint announcement. In this announcement, we shared our intention to achieve convergence of ECS and OTel Semantic Conventions into a single standard maintained by OpenTelemetry.
Special guidance is provided during the donation period. Please review the contribution guide.
Documentation
The ECS reference is published on the main Elastic documentation website.
Visit the official ECS Reference Documentation.
Getting Started
Please review the tooling usage guide to get started using the tools provided in this repo.
Contributing
If you're looking to contribute to ECS, you're invited to look at our contribution guide. Substantial changes to ECS are completed through our RFC process.
Generated artifacts
Various kinds of files or programs can be generated based on ECS. You can learn more in generated/README.md
Releases of ECS
The main branch of this repository should never be considered an official release of ECS. You can browse official releases of ECS here.
The ECS team publishes improvements to the schema by following Semantic Versioning. Generally major ECS releases are planned to be aligned with major Elastic Stack releases.
License
This software is licensed under the Apache License, version 2 ("ALv2"), quoted below.
Copyright 2018-2021 Elasticsearch https://www.elastic.co
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.