Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates on self-assesment, security-insights, and security.md file or passing CLOMonitor checks #4912

Merged
merged 6 commits into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions SECURITY-INSIGHTS.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,5 @@ dependencies:
sbom-url: https://github.com/anchore/sbom-action
dependencies-lifecycle:
policy-url: https://github.com/jaegertracing/jaeger/blob/main/SECURITY.md#security-patch-policy
env-depedencies-policy:
jkowall marked this conversation as resolved.
Show resolved Hide resolved
policy-url: https://github.com/jaegertracing/jaeger/blob/main/SECURITY.md#dependencies-lifecycle-policy
jkowall marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Security fixes are given priority and might be enough to cause a new version to

CVEs in Jaeger code will be patched in the newest Jaeger releases.

### Dependencies Lifecycle Policy
### Dependency Policy

Dependencies are evaluated before being introduced to ensure they:

Expand Down
50 changes: 44 additions & 6 deletions SELF-ASSESMENT.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Jaeger Self-Assessment
This is a placeholder document for the Jaeger project self-assessment. More details of what this will turn into can be found in the [TAG-Security documented standards.](https://github.com/cncf/tag-security/blob/main/assessments/guide/self-assessment.md) ​
# Self-assessment

# Self-assessment outline

## Table of contents

## Table of Contents
* [Metadata](#metadata)
* [Security links](#security-links)
* [Overview](#overview)
Expand All @@ -17,4 +17,42 @@ This is a placeholder document for the Jaeger project self-assessment. More deta
* [Project compliance](#project-compliance)
* [Secure development practices](#secure-development-practices)
* [Security issue resolution](#security-issue-resolution)
* [Appendix](#appendix)## Table of Contents
* [Appendix](#appendix)

## Metadata

| | |
| -- | -- |
| Software | https://github.com/jaegertracing/jaeger/ |
| Security Provider | No |
| Languages | Go |
| SBOM | [Software bill of materials](https://github.com/jaegertracing/jaeger/releases/latest/download/jaeger-SBOM.spdx.json) |
| | |

### Security links

Provide the list of links to existing security documentation for the project. You may
use the table below as an example:
| Doc | url |
| -- | -- |
| Security file | https://github.com/jaegertracing/jaeger/blob/main/SECURITY.md |

## Overview
jkowall marked this conversation as resolved.
Show resolved Hide resolved

Jaeger is an open-source distributed tracing system designed to provide end-to-end visibility into complex, microservices-based architectures. It captures and visualizes traces of requests, allowing developers to monitor and troubleshoot performance issues within their applications.
jkowall marked this conversation as resolved.
Show resolved Hide resolved

### Background

Jaeger is an open-source distributed tracing system developed by Uber Technologies and later donated to the Cloud Native Computing Foundation (CNCF). It is designed to help developers monitor and troubleshoot complex, microservices-based architectures by providing insights into the flow of requests and the performance of individual components.

The primary goal of Jaeger is to provide end-to-end visibility into distributed systems. It accomplishes this by capturing and visualizing traces, which are records of the life cycle of a request as it propagates through various services. Traces consist of a sequence of spans, where each span represents a single operation within a service. Spans are connected to form a trace tree, illustrating the causal relationship between different operations.

Key features of Jaeger include:

Trace Collection and Storage: Jaeger provides agents and collectors that capture traces emitted by instrumented services. The collected traces are stored in a back-end storage system, such as Elasticsearch or Apache Cassandra, for further analysis and querying.

Trace Visualization: Jaeger offers a web-based user interface that allows users to explore and analyze traces. It provides features like trace search, filtering, and detailed visualization of spans, enabling developers to identify performance bottlenecks and troubleshoot issues within their applications.

Integration with Ecosystem: Jaeger integrates with various frameworks, libraries, and platforms commonly used in microservices architectures. It provides client libraries for popular programming languages like Java, Go, Python, and more, making it easier to instrument applications for tracing.

Since being donated to the CNCF, Jaeger has gained significant adoption and has become an integral part of the cloud-native ecosystem. It is widely used by organizations to gain insights into the performance and behavior of their distributed systems, aiding in troubleshooting, performance optimization, and overall system understanding. The project continues to evolve and improve with contributions from a vibrant open-source community.
Loading