cleanup(sinsp)!: remove mesos and k8s filterchecks and move some k8s filtechecks under container.
#1489
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,6 +32,27 @@ using namespace std; | |
| return (uint8_t*) (x).c_str(); \ | ||
| } while(0) | ||
|
|
||
| // We use a macro to avoid a performance overhead, even using an inline function | ||
| // we are not sure the compiler will inline it | ||
| #define CHECK_LABEL_PRESENCE(x) \ | ||
| if(is_host || !container_info) \ | ||
| { \ | ||
| return nullptr; \ | ||
| } \ | ||
| else \ | ||
| { \ | ||
| auto label = container_info->m_labels.find(x); \ | ||
| if(label != container_info->m_labels.end()) \ | ||
| { \ | ||
| m_tstr = label->second; \ | ||
| RETURN_EXTRACT_STRING(m_tstr); \ | ||
| } \ | ||
| else \ | ||
| { \ | ||
| return nullptr; \ | ||
| } \ | ||
| } | ||
|
|
||
| static const filtercheck_field_info sinsp_filter_check_container_fields[] = | ||
| { | ||
| {PT_CHARBUF, EPF_NONE, PF_NA, "container.id", "Container ID", "The truncated container id (first 12 characters)."}, | ||
|
|
@@ -57,6 +78,11 @@ static const filtercheck_field_info sinsp_filter_check_container_fields[] = | |
| {PT_RELTIME, EPF_NONE, PF_DEC, "container.duration", "Number of nanoseconds since container.start_ts", "Number of nanoseconds since container.start_ts."}, | ||
| {PT_CHARBUF, EPF_NONE, PF_NA, "container.ip", "Container ip address", "The container's / pod's primary ip address as retrieved from the container engine. Only ipv4 addresses are tracked. Consider container.cni.json (CRI use case) for logging ip addresses for each network interface."}, | ||
| {PT_CHARBUF, EPF_NONE, PF_NA, "container.cni.json", "Container's / pod's CNI result json", "The container's / pod's CNI result field from the respective pod status info. It contains ip addresses for each network interface exposed as unparsed escaped JSON string. Supported for CRI container engine (containerd, cri-o runtimes), optimized for containerd (some non-critical JSON keys removed). Useful for tracking ips (ipv4 and ipv6, dual-stack support) for each network interface (multi-interface support)."}, | ||
| {PT_CHARBUF, EPF_NONE, PF_NA, "container.k8s.pod.name", "Pod Name", "When the container belongs to a Kubernetes pod it provides the pod name."}, | ||
|
There was a problem hiding this comment. It would be great if we could chat about such major breaking production changes as a team beforehand. For example, I'm not completely sold on the idea of breaking our naming convention. Totally fine to list them under container fields, but I think keeping the old names could work just as well. Or we keep the old k8s filtercheck category (my personal preference). These fields are pretty delicate for real-world production, so we need to be more careful compared to some other low-impact refactors. I would suggest to focus on removing mesos and the old k8s client in this PR. We can hold off on these particular changes until we've had a chance to discuss it further. Especially rushing this into the code base a few days before the next libs release appears to not be in the best interest of the project. For example I wasn't even aware of these renaming plans, I thought we just wanted to remove the old components. I would be very curious to hear what the other maintainers are recommending. /hold There was a problem hiding this comment. I chose this approach for a technical constraint we have today: plugins cannot redefine filter checks already defined in libsinsp. This is exactly the case we have here with the new k8s plugin, we cannot redefine
BTW I agree that we could have been more explicit, sorry for that... I'm happy to hear ideas/suggestions/concerns of other maintainers There was a problem hiding this comment. Focusing my response on the end user interface / result. I understand the technical constraints, we can discuss them more after we have decided. From my perspective (considering today's k8s fields) the I agree wrt the confusion around the Some more thoughts:
|
||
| {PT_CHARBUF, EPF_NONE, PF_NA, "container.k8s.pod.id", "Pod ID", "When the container belongs to a Kubernetes pod it provides the pod id."}, | ||
| {PT_CHARBUF, EPF_ARG_REQUIRED, PF_NA, "container.k8s.pod.label", "Pod Label", "When the container belongs to a Kubernetes pod it provides a specific pod label. 'container.k8s.pod.label[foo]'."}, | ||
| {PT_CHARBUF, EPF_IS_LIST, PF_NA, "container.k8s.pod.labels", "Pod Labels", "When the container belongs to a Kubernetes pod it provides the pod comma-separated key/value labels. E.g. '(foo1:bar1,foo2:bar2)'."}, | ||
| {PT_CHARBUF, EPF_NONE, PF_NA, "container.k8s.ns.name", "Pod Namespace Name", "When the container belongs to a Kubernetes pod it provides the pod namespace name."}, | ||
| }; | ||
|
|
||
| sinsp_filter_check_container::sinsp_filter_check_container() | ||
|
|
@@ -73,34 +99,47 @@ sinsp_filter_check* sinsp_filter_check_container::allocate_new() | |
| return (sinsp_filter_check*) new sinsp_filter_check_container(); | ||
| } | ||
|
|
||
| int32_t sinsp_filter_check_container::extract_arg(const std::string& val, size_t basepos, container_arg_type type) | ||
| { | ||
| size_t start = val.find_first_of('[', basepos); | ||
| if(start == string::npos) | ||
| { | ||
| throw sinsp_exception("the field '" + val + "' requires an argument but '[' is not found"); | ||
| } | ||
|
|
||
| size_t end = val.find_first_of(']', start); | ||
| if(end == string::npos) | ||
| { | ||
| throw sinsp_exception("the field '" + val + "' requires an argument but ']' is not found"); | ||
| } | ||
|
|
||
| string str = val.substr(start + 1, end-start-1); | ||
|
|
||
| if(type == container_arg_type::TYPE_S32) | ||
| { | ||
| try | ||
| { | ||
| m_argid = sinsp_numparser::parsed32(str); | ||
| } | ||
| catch (const sinsp_exception& e) | ||
| { | ||
| if(strstr(e.what(), "is not a valid number") == NULL) | ||
| { | ||
| throw; | ||
| } | ||
|
|
||
| m_argid = -1; | ||
| m_argstr = str; | ||
| } | ||
| } | ||
| else if(type == container_arg_type::TYPE_STRING) | ||
| { | ||
| m_argstr = str; | ||
| } | ||
| else | ||
| { | ||
| ASSERT(false); | ||
| throw sinsp_exception("argument type unknown during 'sinsp_filter_check_container::extract_arg'"); | ||
| } | ||
|
|
||
| return end+1; | ||
|
|
@@ -149,15 +188,25 @@ int32_t sinsp_filter_check_container::parse_field_name(const char* str, bool all | |
| } | ||
| m_field = &m_info.m_fields[m_field_id]; | ||
|
|
||
| res = extract_arg(val, basepos, container_arg_type::TYPE_S32); | ||
| } | ||
| else if (val.find("container.mount") == 0 && | ||
| val[basepos-1] != 's') | ||
| { | ||
| m_field_id = TYPE_CONTAINER_MOUNT; | ||
| m_field = &m_info.m_fields[m_field_id]; | ||
|
|
||
| res = extract_arg(val, basepos-1, container_arg_type::TYPE_S32); | ||
| } | ||
| // We need to check that is `pod.label` and not `pod.labels` | ||
| else if(val.find("container.k8s.pod.label") == 0 && | ||
| val[sizeof("container.k8s.pod.label")-1] != 's') | ||
| { | ||
| m_field_id = TYPE_CONTAINER_K8S_POD_LABEL; | ||
| m_field = &m_info.m_fields[m_field_id]; | ||
|
|
||
| // We don't need to check the return value, if no arg was specified we throw an exception | ||
| res = extract_arg(val, sizeof("container.k8s.pod.label")-1, container_arg_type::TYPE_STRING); | ||
| } | ||
| else | ||
| { | ||
|
|
@@ -574,10 +623,121 @@ uint8_t* sinsp_filter_check_container::extract(sinsp_evt *evt, OUT uint32_t* len | |
| RETURN_EXTRACT_STRING(container_info->m_pod_cniresult); | ||
| } | ||
| break; | ||
| case TYPE_CONTAINER_K8S_POD_NAME: | ||
| CHECK_LABEL_PRESENCE("io.kubernetes.pod.name"); | ||
| break; | ||
| case TYPE_CONTAINER_K8S_POD_ID: | ||
| CHECK_LABEL_PRESENCE("io.kubernetes.pod.uid"); | ||
| break; | ||
| case TYPE_CONTAINER_K8S_POD_LABEL: | ||
| if(is_host || !container_info) | ||
| { | ||
| return nullptr; | ||
| } | ||
| else | ||
| { | ||
| auto label = container_info->m_labels.find("io.kubernetes.sandbox.id"); | ||
| if(label == container_info->m_labels.end()) | ||
| { | ||
| return nullptr; | ||
| } | ||
|
|
||
| std::string sandbox_container_id = label->second; | ||
| if(sandbox_container_id.size() > 12) | ||
| { | ||
| sandbox_container_id.resize(12); | ||
| } | ||
| const auto sandbox_container_info = m_inspector->m_container_manager.get_container(sandbox_container_id); | ||
| if(!sandbox_container_info || sandbox_container_info->m_labels.empty()) | ||
| { | ||
| return nullptr; | ||
| } | ||
|
|
||
| label = sandbox_container_info->m_labels.find(m_argstr); | ||
| if(label == sandbox_container_info->m_labels.end()) | ||
| { | ||
| return nullptr; | ||
| } | ||
| m_tstr = label->second; | ||
| RETURN_EXTRACT_STRING(m_tstr); | ||
| } | ||
| break; | ||
| case TYPE_CONTAINER_K8S_NS_NAME: | ||
| CHECK_LABEL_PRESENCE("io.kubernetes.pod.namespace"); | ||
| break; | ||
| default: | ||
| ASSERT(false); | ||
| break; | ||
| } | ||
|
|
||
| return NULL; | ||
| } | ||
|
|
||
| bool sinsp_filter_check_container::extract(sinsp_evt* evt, OUT std::vector<extract_value_t>& values, | ||
| bool sanitize_strings) | ||
| { | ||
| values.clear(); | ||
|
|
||
| // `TYPE_CONTAINER_K8S_POD_LABELS` has the `EPF_IS_LIST` flag. | ||
| if(m_field_id == TYPE_CONTAINER_K8S_POD_LABELS) | ||
| { | ||
| sinsp_threadinfo* tinfo = evt->get_thread_info(); | ||
| // Without the container id we can do nothing | ||
| if(tinfo == nullptr || tinfo->m_container_id.empty()) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| auto container_info = m_inspector->m_container_manager.get_container(tinfo->m_container_id); | ||
|
|
||
| if(container_info == nullptr) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| // We need the label `io.kubernetes.sandbox.id` to extract pod labels. | ||
| auto sandbox_label = container_info->m_labels.find("io.kubernetes.sandbox.id"); | ||
| if(sandbox_label == container_info->m_labels.end()) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| std::string sandbox_container_id = sandbox_label->second; | ||
| if(sandbox_container_id.size() > 12) | ||
| { | ||
| sandbox_container_id.resize(12); | ||
| } | ||
| const auto sandbox_container_info = | ||
| m_inspector->m_container_manager.get_container(sandbox_container_id); | ||
|
|
||
| if(sandbox_container_info == nullptr || sandbox_container_info->m_labels.empty()) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| // Clean a possible not empty storage | ||
| m_labels_storage.clear(); | ||
| for(const auto& label : sandbox_container_info->m_labels) | ||
| { | ||
| // Exclude annotations and internal labels | ||
| if(label.first.find("annotation.") == 0 || label.first.find("io.kubernetes.") == 0) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| // We use a storage because these strings should survive until the next filtercheck call. | ||
| m_labels_storage.emplace_back(label.first + ":" + label.second); | ||
| } | ||
|
|
||
| for(const auto& label : m_labels_storage) | ||
| { | ||
| extract_value_t val; | ||
| val.ptr = (uint8_t*)label.c_str(); | ||
| val.len = label.size(); | ||
| values.emplace_back(val); | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| return sinsp_filter_check::extract(evt, values, sanitize_strings); | ||
| } | ||
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.
👍