-
Notifications
You must be signed in to change notification settings - Fork 13
Add Network Map documentation #703
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
Open
cpipilas
wants to merge
24
commits into
master
Choose a base branch
from
cpi_SC-22507_add_network_map
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
884aa17
Add Network Map documentation
cpipilas 722117e
Add Network Map card to main docs page
cpipilas cf1d713
Add supported services page for Network Map
cpipilas 3f6c54f
Add supported protocols section
cpipilas 5591d27
Add architecture diagram replacement benefit
cpipilas 64a34fd
Add use cases section for security and cost scenarios
cpipilas 3f663b6
Use standalone hosts terminology for non-Kubernetes infrastructure
cpipilas cb2c8a0
Clarify memory threshold documentation to explain RSS metric
cpipilas 8128f1c
Convert all internal links to absolute paths
cpipilas da7eec3
Add EU Sematext Cloud link for Infra App creation
cpipilas 929cd3e
Add annotation to outdated agents screenshot
cpipilas 47ff770
Add processes to Kubernetes drill-down hierarchy
cpipilas c84baee
Add processes to K8s hierarchy and improve Network Map cross-linking
cpipilas b0aba6f
Rename Filtering & Search page title to include Network Map
cpipilas 83e80b3
Add containers and processes to search description
cpipilas 989e653
Improve High CPU filter description wording
cpipilas da2926b
Clarify Bare-Metal includes VMs and cloud instances
cpipilas 24b29f0
Clarify disk I/O refers to database queries
cpipilas da14d93
Add Fleet links for agent management in troubleshooting
cpipilas 381dd74
Clarify initial data collection delay
cpipilas 77689d2
Add instructions for finding Infra App token
cpipilas 50fec24
Improve descriptions and clarify dynamic activation
cpipilas b8f4ab7
Improve wording in Network Map overview
cpipilas 9005c96
Fix App Settings label and grammar
cpipilas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| title: Filtering & Search | ||
cpipilas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| description: Find and filter specific services, infrastructure, and connections in Network Map. | ||
|
|
||
| When you're managing dozens or hundreds of services, you need ways to focus on what matters. Network Map provides powerful filtering and search capabilities that help you cut through the noise and find exactly what you're looking for. | ||
|
|
||
|  | ||
|
|
||
| ## Finding Services with Search | ||
|
|
||
| The search bar at the top of Network Map lets you quickly find specific services, nodes, pods, or hosts by name. Just start typing and matching elements are highlighted on the map. | ||
cpipilas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Quick Filters for Common Problems | ||
|
|
||
| Click the Filters button to open the Services Filters panel. At the top, you'll find Quick Filters - pre-configured filters based on your [threshold settings](thresholds.md) that highlight common problem areas: | ||
|
|
||
| **High Network** (>10MB/s) shows services with high network I/O. Use this to find services that might be bandwidth-constrained or experiencing unusual traffic. | ||
|
|
||
| **High Disk I/O** (>70MB/s) reveals services with elevated disk activity. This helps identify storage bottlenecks or services that might benefit from caching. | ||
|
|
||
| **High CPU** (>70% usage) filters to services consuming significant CPU. When your cluster is running hot, this immediately shows you where the load is coming from. | ||
cpipilas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| **High Memory** (>80% usage) displays services approaching their memory limits. Catching these early helps prevent OOM kills and service disruptions. | ||
|
|
||
| These quick filters are especially useful during incident response - instead of scanning the entire map, click "High CPU" to immediately see which services are struggling. The threshold values shown are defined in your [Threshold Settings](thresholds.md). | ||
|
|
||
| ## Filtering by Environment | ||
|
|
||
| The Environment & Infrastructure section lets you focus on specific parts of your infrastructure: | ||
|
|
||
| Use the **Environment Type** checkboxes to filter by **Kubernetes** or **Bare-Metal** services. Each option displays a count of matching services, so you know how many elements will appear after filtering. You can select both to see your entire infrastructure, or focus on just one environment type. | ||
cpipilas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Filtering by Service Type | ||
|
|
||
| The **Service Types** section lets you filter by specific technologies. Use the checkboxes to select one or more service types from the paginated list: | ||
|
|
||
| Looking for database issues? Select MySQL, PostgreSQL, or MongoDB to show only your database services. Troubleshooting messaging? Filter to Kafka and RabbitMQ. Investigating web traffic? Select Nginx and Apache. | ||
cpipilas marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| The list shows counts next to each service type (like "2 services"), helping you understand your infrastructure composition at a glance. Use the search box to quickly find a specific service type, or use the pagination controls to browse through all available types. | ||
|
|
||
| ## Filtering by Performance Metrics | ||
|
|
||
| The **Performance & Metrics** section provides sliders to filter based on resource consumption: | ||
|
|
||
| - **Network Traffic Rate (MB/s)** - Filter by network traffic volume to find your busiest services or investigate bandwidth issues | ||
| - **Disk I/O Rate (MB/s)** - Filter by disk throughput to identify I/O-intensive services | ||
| - **Connection Count** - Filter by the number of active connections to find services with many connections | ||
|
|
||
| These sliders work as minimum thresholds - services above your selected value appear on the map. | ||
|
|
||
| ## Color Coding Options | ||
|
|
||
| The "Color By" dropdown in the top-right corner controls how services and connections are visually represented: | ||
|
|
||
|  | ||
|
|
||
| **Nodes** (service cards and infrastructure elements): | ||
|
|
||
| - Network I/O | ||
| - CPU Usage | ||
| - Memory Usage | ||
| - Disk I/O | ||
|
|
||
| **Edges** (connection lines): | ||
|
|
||
| - Traffic Volume | ||
| - Connection Health | ||
|
|
||
| Choose the metric most relevant to your current investigation. Traffic volume helps identify your busiest connections, while connection health highlights latency or reliability issues. | ||
|
|
||
| The color scale uses green for healthy values (below your warning threshold), yellow for warning levels (between warning and critical), and red for critical values (above your critical threshold). Gray indicates no data is available. | ||
|
|
||
| This color coding works with your [threshold configuration](thresholds.md), so you can customize what "healthy" and "critical" mean for your environment. | ||
|
|
||
| ## Combining Filters | ||
|
|
||
| Filters combine to narrow your view progressively. For example, you might: | ||
|
|
||
| 1. Select "Kubernetes" to focus on containerized services | ||
| 2. Filter to "PostgreSQL" service type to see only your databases | ||
| 3. Apply the "High CPU" quick filter to find which databases are working hardest | ||
|
|
||
| The map updates immediately as you apply each filter, showing you only the services that match all your criteria. | ||
|
|
||
| ## Clearing Filters | ||
|
|
||
| To reset your view, click "Clear All" in the filters panel or close the panel to return to showing all services. Individual filter sections also have their own clear options if you want to remove just one filter while keeping others. | ||
|
|
||
| ## Practical Examples | ||
|
|
||
| **During an incident**: Open Quick Filters and click "High CPU" and "High Memory" to immediately see which services are resource-constrained. This is much faster than scanning the entire map. | ||
|
|
||
| **Capacity planning**: Filter by service type to see all instances of a particular technology. Examine their resource usage to determine if you need to scale. | ||
|
|
||
| **Investigating a namespace**: Use search to find services in a specific namespace, or filter by Kubernetes and then examine the namespace tags on each service. | ||
|
|
||
| **Finding connection issues**: Color edges by Connection Health, then look for red lines indicating problematic connections. Click on them to see latency and error details. | ||
|
|
||
| **Cost optimization**: Filter by low CPU and memory usage to find over-provisioned services that could be downsized. Look for services with minimal traffic that might be candidates for consolidation or removal. Identify redundant services running the same workload across multiple instances when fewer would suffice. | ||
|
|
||
| ## Next Steps | ||
|
|
||
| - [Thresholds](thresholds.md) to customize what "High CPU" and other quick filters mean for your environment | ||
| - [Services View](services-view.md) to understand the tier-based service layout | ||
| - [Infrastructure View](infrastructure-view.md) to drill down into Kubernetes and bare-metal infrastructure | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| title: Getting Started with Network Map | ||
| description: Learn the prerequisites and how to enable Network Map for your infrastructure. | ||
|
|
||
| Getting Network Map up and running takes just a few minutes if you already have Sematext Infra Monitoring in place. If you're new to Sematext, this guide walks you through everything you need. | ||
|
|
||
| ## What You Need | ||
|
|
||
| Network Map requires two things: | ||
|
|
||
| **An [Infra App](../monitoring/infrastructure.md)** to collect and store your infrastructure data. If you're already using Sematext for infrastructure monitoring, you have this. If not, you'll create one as part of the setup process. | ||
|
|
||
| **[Sematext Agent](../agents/sematext-agent/installation/)** installed on the hosts you want to monitor. The agent collects eBPF-based network connection data that powers Network Map's topology visualization. You need version 4.1.x or later. | ||
|
|
||
| For best results, your hosts should be running **Linux kernel 5.8 or later**. Older kernels (4.15+) work but with some limitations. Check your kernel version with `uname -r`. | ||
|
|
||
| ## Enabling Network Map | ||
|
|
||
| Navigate to Network Map in the Sematext Cloud sidebar. What you see next depends on your current setup: | ||
|
|
||
| ### If You Don't Have an Infra App | ||
|
|
||
|  | ||
|
|
||
| You'll be prompted to create an Infra App first. Click "Create New Infra App" to create one, give it a name (like "Production Infrastructure" or "Staging Environment"), and you're set. | ||
|
|
||
| Each Infra App typically represents one environment. Many teams have separate Infra Apps for production, staging, and development. | ||
|
|
||
| ### If You Have an Infra App But No Agents | ||
|
|
||
| You'll see instructions to install [Sematext Agent](../agents/sematext-agent/installation/). The installation is straightforward - you'll get a command to run on each host that includes your Infra App token. | ||
|
|
||
| For Kubernetes environments, you'll deploy the agent as a DaemonSet so it runs on every node automatically. | ||
|
|
||
| ### If Everything Is Ready | ||
|
|
||
| When you have an Infra App and agents installed, you'll see a summary of your infrastructure showing the number of hosts, Kubernetes clusters, pods, and containers that Network Map will monitor. If you've already enabled Network Map, you'll skip this screen and see your data directly. | ||
|
|
||
|  | ||
|
|
||
| Click the Enable button to activate Network Map. There's no need to configure anything on your agents - the backend automatically enables Network Map data collection when you enable the feature. Your agents will start sending topology data right away. | ||
|
|
||
| ## What Happens After Enabling | ||
|
|
||
| Once enabled, here's what to expect: | ||
|
|
||
| **Data collection begins immediately.** The Sematext Agent starts observing network connections and sending topology data to Sematext Cloud. | ||
|
|
||
| **Initial topology appears within minutes.** You'll see your first services and connections show up in Network Map. The visualization builds as the agent observes more connections. | ||
|
|
||
| **The map becomes more complete over time.** Services that haven't made network connections yet won't appear until they do. As your infrastructure communicates, Network Map captures more of the topology. | ||
|
|
||
| **No restart required.** Your agents don't need to restart when you enable Network Map. The feature activates dynamically. | ||
cpipilas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Verifying It's Working | ||
|
|
||
| After a few minutes, you should see: | ||
|
|
||
| - Service nodes appearing on the map | ||
| - Connection lines between services showing protocols and traffic | ||
| - Your Kubernetes clusters and nodes (if applicable) in the Infrastructure view | ||
|
|
||
| If nothing appears after 10 minutes, check the [Troubleshooting](troubleshooting.md) guide. | ||
|
|
||
| ## Using the Quick Guide | ||
|
|
||
| Click the **Quick Guide** button in the top-right corner of Network Map to see a visual legend explaining the interface. The Quick Guide shows you what the different node colors mean (green for healthy, yellow for warning, red for critical), how connection lines are colored based on traffic volume and health, and what controls are available. It's a handy reference while you're learning the interface. | ||
|
|
||
|  | ||
|
|
||
| ## Pricing | ||
|
|
||
| For Network Map pricing details, visit [sematext.com/pricing](https://sematext.com/pricing). | ||
|
|
||
| ## Next Steps | ||
|
|
||
| Once Network Map is running: | ||
|
|
||
| - [Services View](services-view.md) - Explore your services organized by tier | ||
| - [Infrastructure View](infrastructure-view.md) - Drill down into Kubernetes clusters and bare-metal hosts | ||
| - [Filtering & Search](filtering-search.md) - Learn to find and filter specific services | ||
| - [Thresholds](thresholds.md) - Customize warning and critical levels for your environment | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here with the 0 (here's a picture without it):
