Skip to content

Commit 5900417

Browse files
cstyanJStickler
andauthored
chore: Add notes about promtail being feature complete (#12827)
Signed-off-by: Callum Styan <[email protected]> Co-authored-by: J Stickler <[email protected]>
1 parent 3070ea7 commit 5900417

File tree

3 files changed

+5
-0
lines changed

3 files changed

+5
-0
lines changed

.github/pull_request_template.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Fixes #<issue number>
1010
- [ ] Documentation added
1111
- [ ] Tests updated
1212
- [ ] Title matches the required conventional commits format, see [here](https://www.conventionalcommits.org/en/v1.0.0/)
13+
- **Note** that Promtail is considered to be feature complete, and future development for logs collection will be in [Grafana Alloy](https://github.com/grafana/alloy). As such, `feat` PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
1314
- [ ] Changes that require user attention or interaction to upgrade are documented in `docs/sources/setup/upgrade/_index.md`
1415
- [ ] For Helm chart changes bump the Helm chart version in `production/helm/loki/Chart.yaml` and update `production/helm/loki/CHANGELOG.md` and `production/helm/loki/README.md`. [Example PR](https://github.com/grafana/loki/commit/d10549e3ece02120974929894ee333d07755d213)
1516
- [ ] If the change is deprecating or removing a configuration option, update the `deprecated-config.yaml` and `deleted-config.yaml` files respectively in the `tools/deprecated-config-checker` directory. [Example PR](https://github.com/grafana/loki/pull/10840/commits/0d4416a4b03739583349934b96f272fb4f685d15)

CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Loki uses GitHub to manage reviews of pull requests:
66
- If you plan to do something more involved, discuss your ideas on the relevant GitHub issue.
77
- Make sure to follow the prerequisites below before marking your PR as ready for review.
88

9+
**Note that Promtail is considered to be feature complete, and future development for logs collection will be in [Grafana Alloy](https://github.com/grafana/alloy)**
10+
911
## Loki Improvement Documents (LIDs)
1012

1113
Before creating a large pull request to change or add functionality, please create a _Loki Improvement Document (LID)_. We use LIDs to discuss and vet ideas submitted by maintainers or the community in an open and transparent way. As of Jan 2023, we are starting with a lightweight LID process and we may add more structure, inspired by Python's [PEP](https://peps.python.org/pep-0001/) and Kafka's [KIP](https://cwiki.apache.org/confluence/display/KAFKA/Kafka+Improvement+Proposals) approaches.

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ A Loki-based logging stack consists of 3 components:
2424
- `loki` is the main server, responsible for storing logs and processing queries.
2525
- [Grafana](https://github.com/grafana/grafana) for querying and displaying the logs.
2626

27+
**Note that Promtail is considered to be feature complete, and future development for logs collection will be in [Grafana Alloy](https://github.com/grafana/alloy)**
28+
2729
Loki is like Prometheus, but for logs: we prefer a multidimensional label-based approach to indexing, and want a single-binary, easy to operate system with no dependencies.
2830
Loki differs from Prometheus by focusing on logs instead of metrics, and delivering logs via push, instead of pull.
2931

0 commit comments

Comments
 (0)