Class: Fluent::Plugin::Zebrium
- Inherits:
-
Output
- Object
- Output
- Fluent::Plugin::Zebrium
- Defined in:
- lib/fluent/plugin/out_zebrium.rb
Constant Summary collapse
- DEFAULT_LINE_FORMAT_TYPE =
'stdout'
- DEFAULT_FORMAT_TYPE =
'json'
- DEFAULT_BUFFER_TYPE =
"memory"
- DEFAULT_DEPLOYMENT_NAME =
"default"
Instance Attribute Summary collapse
-
#formatter ⇒ Object
Returns the value of attribute formatter.
Instance Method Summary collapse
-
#add_kubernetes_cfgs_for_pod_id(in_cfgs) ⇒ Object
If the current configuration has a pod_id matching one of the previously stored ones any associated k8s config info will be added.
-
#configure(conf) ⇒ Object
This method is called before starting.
- #get_container_meta_data(container_id) ⇒ Object
- #get_ec2_host_meta_data ⇒ Object
- #get_host ⇒ Object
- #get_k8s_event_str(record) ⇒ Object
- #get_request_headers(chunk_tag, record) ⇒ Object
- #get_stream_token(ids, cfgs, tags, logbasename, is_container_log, user_mapping, log_type, forwarded_log) ⇒ Object
-
#initialize ⇒ Zebrium
constructor
A new instance of Zebrium.
- #map_path_ids(tailed_path, ids, cfgs, tags) ⇒ Object
- #multi_workers_ready? ⇒ Boolean
- #post_data(uri, data, headers) ⇒ Object
- #post_message_data(send_json, headers, messages) ⇒ Object
- #prefer_buffered_processing ⇒ Object
- #prepare_support_data ⇒ Object
- #process(tag, es) ⇒ Object
- #read_file_mappings ⇒ Object
-
#read_ns_to_svcgrp_mappings ⇒ Object
def format(tag, time, record) record = inject_values_to_record(tag, time, record) @formatter.format(tag, time, record).chomp + ānā end.
- #read_path_mappings ⇒ Object
-
#save_kubernetes_cfgs(cfgs) ⇒ Object
save kubernetes configues, related to a specifc pod_id for potential use later for container file-based logs.
- #send_support_data(data) ⇒ Object
-
#shutdown ⇒ Object
This method is called when shutting down.
-
#start ⇒ Object
This method is called when starting.
- #write(chunk) ⇒ Object
Constructor Details
#initialize ⇒ Zebrium
Returns a new instance of Zebrium.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 95 def initialize super @etc_hostname = "" @k8s_hostname = "" if File.exist?("/mnt/etc/hostname") # Inside fluentd container # In that case that host /etc/hostname is a directory, we will # get empty string (for example, on GKE hosts). We will # try to get hostname from log record from kubernetes. if File.file?("/mnt/etc/hostname") File.open("/mnt/etc/hostname", "r").each do |line| @etc_hostname = line.strip().chomp end end else if File.exist?("/etc/hostname") # Run directly on host File.open("/etc/hostname", "r").each do |line| @etc_hostname = line.strip().chomp end end if @etc_hostname.empty? @etc_hostname = `hostname`.strip().chomp end end # Pod names can have two formats: # 1. <deployment_name>-84ff57c87c-pc6xm # 2. <deployment_name>-pc6xm # We use the following two regext to find deployment name. Ideally we want kubernetes filter # to pass us deployment name, but currently it doesn't. @pod_name_to_deployment_name_regexp_long_compiled = Regexp.compile('(?<deployment_name>[a-z0-9]([-a-z0-9]*))-[a-f0-9]{9,10}-[a-z0-9]{5}') @pod_name_to_deployment_name_regexp_short_compiled = Regexp.compile('(?<deployment_name>[a-z0-9]([-a-z0-9]*))-[a-z0-9]{5}') @stream_tokens = {} @stream_token_req_sent = 0 @stream_token_req_success = 0 @data_post_sent = 0 @data_post_success = 0 @support_post_sent = 0 @support_post_success = 0 @last_support_data_sent = 0 end |
Instance Attribute Details
#formatter ⇒ Object
Returns the value of attribute formatter.
145 146 147 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 145 def formatter @formatter end |
Instance Method Details
#add_kubernetes_cfgs_for_pod_id(in_cfgs) ⇒ Object
If the current configuration has a pod_id matching one of the previously stored ones any associated k8s config info will be added.
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 481 def add_kubernetes_cfgs_for_pod_id(in_cfgs) if (not in_cfgs.key?("pod_id")) or in_cfgs.fetch("pod_id").nil? return in_cfgs end pod_id = in_cfgs["pod_id"] if not @pod_configs.cfgs.key?(pod_id) return in_cfgs end pod_cfgs = @pod_configs.cfgs(pod_id) # Ruby times are UNIX time in seconds. Toss this if unused for # 10 minutes as it may be outdated if Time.now() - pod_cfgs.atime > 60*10 @pod_configs.cfgs.delete(pod_id) # while paying the cost, do a quick check for old entries @pod_configs.cfgs.each do |pod_id, cfg| if Time.now() - cfg.atime > 60*10 @pod_configs.cfgs.delete(pod_id) break end end return in_cfgs end pod_cfgs.atime = Time.now() pod_cfgs.cfgs.each do |key, value| in_cfgs[key] = value end return in_cfgs end |
#configure(conf) ⇒ Object
This method is called before starting.
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 148 def configure(conf) log.info("out_zebrium::configure() called") compat_parameters_convert(conf, :inject, :formatter) super @formatter = formatter_create @ze_tags = {} kvs = conf.key?('ze_host_tags') ? conf['ze_host_tags'].split(','): [] for kv in kvs do ary = kv.split('=') if ary.length != 2 or ary[0].empty? or ary[1].empty? log.error("Invalid tag in ze_host_tags: #{kv}") continue end log.info("add ze_tag[" + ary[0] + "]=" + ary[1]) if ary[0] == "ze_deployment_name" and @ze_deployment_name.empty? log.info("Use ze_deployment_name from ze_tags") @ze_deployment_name = ary[1] else @ze_tags[ary[0]] = ary[1] end end if @ze_deployment_name.empty? log.info("Set deployment name to default value " + DEFAULT_DEPLOYMENT_NAME) @ze_deployment_name = DEFAULT_DEPLOYMENT_NAME end @path_mappings = PathMappings.new @pod_configs = PodConfigs.new @ns_to_svcgrp_mappings = NamespaceToServiceGroup.new read_path_mappings() read_ns_to_svcgrp_mappings() @file_mappings = {} if @log_forwarder_mode log.info("out_zebrium running in log forwarder mode") else read_file_mappings() if @disable_ec2_meta_data == false = () for k in .keys do log.info("add ec2 meta data " + k + "=" + [k]) @ze_tags[k] = [k] end else log.info("EC2 meta data collection is disabled") end end @http = HTTPClient.new() if @verify_ssl @http.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_PEER @http.ssl_config.add_trust_ca "/usr/lib/ssl/certs" else @http.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE end @http.connect_timeout = 60 @zapi_uri = URI(conf["ze_log_collector_url"]) @zapi_token_uri = @zapi_uri.clone @zapi_token_uri.path = @zapi_token_uri.path + "/log/api/v2/token" @zapi_post_uri = @zapi_uri.clone @zapi_post_uri.path = @zapi_post_uri.path + "/log/api/v2/tmpost" @zapi_ingest_uri = @zapi_uri.clone @zapi_ingest_uri.path = @zapi_ingest_uri.path + "/log/api/v2/ingest" @zapi_support_uri = @zapi_uri.clone @zapi_support_uri.path = "/api/v2/support" @auth_token = conf["ze_log_collector_token"] @cluster_name = conf["cluster_name"] log.info("ze_log_collector_vers=" + $ZLOG_COLLECTOR_VERSION) log.info("ze_log_collector_type=" + @ze_log_collector_type) log.info("ze_deployment_name=" + (conf["ze_deployment_name"].nil? ? "<not set>": conf["ze_deployment_name"])) log.info("log_collector_url=" + conf["ze_log_collector_url"]) log.info("etc_hostname=" + @etc_hostname) log.info("ze_forward_tag=" + @ze_forward_tag) log.info("ze_path_map_file=" + @ze_path_map_file) log.info("ze_host_in_logpath=#{@ze_host_in_logpath}") log.info("ze_ns_svcgrp_map_file=" + @ze_ns_svcgrp_map_file) log.info("cluster_name=" +(conf["cluster_name"].nil? ? "<not set>": conf["cluster_name"])) data = {} data['msg'] = "log collector starting" send_support_data(data) end |
#get_container_meta_data(container_id) ⇒ Object
440 441 442 443 444 445 446 447 448 449 450 451 452 453 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 440 def (container_id) = {} begin container = Docker::Container.get(container_id) json = container.json() ['name'] = json['Name'].sub(/^\//, '') ['image'] = json['Config']['Image'] ['labels'] = json['Config']['Labels'] return rescue log.info("Exception: failed to get container (#{container_id} meta data") return nil end end |
#get_ec2_host_meta_data ⇒ Object
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 387 def () = {} token = "" client = HTTPClient.new() client.connect_timeout = @ec2_api_client_timeout_secs begin log.info("Getting ec2 api token") resp = client.put('http://169.254.169.254/latest/api/token', :header => {'X-aws-ec2-metadata-token-ttl-seconds' => '21600'}) if resp.ok? token = resp.body log.info("Got ec2 host meta token=") else log.info("Failed to get AWS EC2 host meta data API token") end rescue log.info("Exception: failed to get AWS EC2 host meta data API token") return end begin log.info("Calling ec2 instance meta data API") = client.get('http://169.254.169.254/latest/meta-data/', :header => {'X-aws-ec2-metadata-token' => token}) log.info("Returned from c2 instance meta call") if .ok? = .body.split() for k in ['ami-id', 'instance-id', 'instance-type', 'hostname', 'local-hostname', 'local-ipv4', 'mac', 'placement', 'public-hostname', 'public-ipv4'] do if .include?(k) data_resp = client.get("http://169.254.169.254/latest/meta-data/" + k, :header => {'X-aws-ec2-metadata-token' => token}) if data_resp.ok? log.info("#{k}=#{data_resp.body}") ['ec2-' + k] = data_resp.body else log.error("Failed to get meta data with key #{k}") end end end else log.error("host meta data request failed: #{}") end rescue log.error("host meta data post request exception") end return end |
#get_host ⇒ Object
432 433 434 435 436 437 438 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 432 def get_host() host = @k8s_hostname.empty? ? @etc_hostname : @k8s_hostname unless @ze_tags["ze_tag_node"].nil? or @ze_tags["ze_tag_node"].empty? host = @ze_tags["ze_tag_node"] end return host end |
#get_k8s_event_str(record) ⇒ Object
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 890 def get_k8s_event_str(record) evt_obj = record['object'] severity = evt_obj['type'] if severity == "Warning" severity = "WARN" end if severity == "Normal" severity = "INFO" end evt_str = "count=" + evt_obj['count'].to_s if record.key?('type') evt_str = evt_str + " type=" + record['type'] end if evt_obj.key?('source') and evt_obj['source'].key('host') evt_str = evt_str + " host=" + evt_obj['source']['host'] end if evt_obj.key?('metadata') if evt_obj['metadata'].key?('name') evt_str = evt_str + " name=" + evt_obj['metadata']['name'] end if evt_obj['metadata'].key('namespace') evt_str = evt_str + " namespace=" + evt_obj['metadata']['namespace'] end end if evt_obj.key?('involvedObject') in_obj = evt_obj['involvedObject'] for k in ["kind", "namespace", "name", "uid" ] do if in_obj.key?(k) evt_str = evt_str + " " + k + "=" + in_obj[k] end end end if evt_obj.key?('reason') evt_str = evt_str + " reason=" + evt_obj['reason'] end # log.info("Event obj:" + evt_obj.to_s) if evt_obj.key?('lastTimestamp') and not evt_obj.fetch('lastTimestamp').nil? timeStamp = evt_obj["lastTimestamp"] elsif evt_obj.key('eventTime') and not evt_obj.fetch('eventTime').nil? timeStamp = evt_obj["eventTime"] else timeStamp = '' end msg = timeStamp + " " + severity + " " + evt_str + " msg=" + evt_obj['message'].chomp return msg end |
#get_request_headers(chunk_tag, record) ⇒ Object
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 513 def get_request_headers(chunk_tag, record) headers = {} ids = {} cfgs = {} = {} # Sometimes 'record' appears to be a simple number, which causes an exception when # used as a hash. Until the underlying issue is addressed detect this and log. if record.class.name != "Hash" or not record.respond_to?(:key?) log.error("Record is not a hash, unable to process (class: ${record.class.name}).") return false, nil, nil end if record.key?("docker") and not record.fetch("docker").nil? container_id = record["docker"]["container_id"] if record.key?("kubernetes") and not record.fetch("kubernetes").nil? cfgs["container_id"] = container_id else ids["container_id"] = container_id end end is_container_log = true log_type = "" forwarded_log = false user_mapping = false fpath = "" override_deployment = "" override_deployment_from_ns_svcgrp_map = "" record_host = "" if record.key?("host") and not record["host"].empty? record_host = record["host"] end has_container_keys = false if record.key?("container_id") and record.key?("container_name") has_container_keys = true end if chunk_tag =~ /^sysloghost\./ or chunk_tag =~ /^#{ze_forward_tag}\./ if record_host.empty? and ze_host_in_logpath > 0 and record.key?("tailed_path") tailed_path = record["tailed_path"] path_components = tailed_path.split("/") if path_components.length() < ze_host_in_logpath log.info("Cannot find host at index #{ze_host_in_logpath} in '#{tailed_path}'") else # note .split has empty first element from initial '/' record_host = path_components[ze_host_in_logpath] end end log_type = "syslog" forwarded_log = true logbasename = "syslog" ids["app"] = logbasename ids["host"] = record_host is_container_log = false elsif record.key?("kubernetes") and not record.fetch("kubernetes").nil? kubernetes = record["kubernetes"] if kubernetes.key?("namespace_name") and not kubernetes.fetch("namespace_name").nil? namespace = kubernetes.fetch("namespace_name") if namespace.casecmp?("orphaned") or namespace.casecmp?(".orphaned") return false, nil, nil end end fpath = kubernetes["container_name"] keys = [ "namespace_name", "host", "container_name" ] for k in keys do if kubernetes.key?(k) and not kubernetes.fetch(k).nil? ids[k] = kubernetes[k] if k == "host" and @k8s_hostname.empty? @k8s_hostname = kubernetes[k] end # Requirement for ZS-2185 add cmdb_role, based on namespace_name if k == "namespace_name" cfgs["cmdb_role"] = kubernetes[k].gsub("-","_") if @ns_to_svcgrp_mappings.active if @ns_to_svcgrp_mappings.svcgrps.key?(kubernetes[k]) and not @ns_to_svcgrp_mappings.svcgrps.fetch(kubernetes[k]).nil? override_deployment_from_ns_svcgrp_map = @ns_to_svcgrp_mappings.svcgrps[kubernetes[k]] end end end end end for pattern in [ @pod_name_to_deployment_name_regexp_long_compiled, @pod_name_to_deployment_name_regexp_short_compiled ] do match_data = kubernetes["pod_name"].match(pattern) if match_data ids["deployment_name"] = match_data["deployment_name"] break end end keys = [ "namespace_id", "container_name", "pod_name", "pod_id", "container_image", "container_image_id" ] for k in keys do if kubernetes.key?(k) and not kubernetes.fetch(k).nil? cfgs[k] = kubernetes[k] end end unless kubernetes["labels"].nil? cfgs.merge!(kubernetes["labels"]) end # Allow Cluster name to be set via an env variable if !@cluster_name.nil? and !@cluster_name.empty? cfgs["cluster_name"] = @cluster_name end # At this point k8s config should be set. Save these so a subsequent file-log # record for the same pod_id can use them. save_kubernetes_cfgs(cfgs) unless kubernetes["namespace_annotations"].nil? = kubernetes["namespace_annotations"] for t in .keys if t == "zebrium.com/ze_service_group" and not [t].empty? override_deployment = [t] end end end unless kubernetes["annotations"].nil? = kubernetes["annotations"] for t in .keys if t == "zebrium.com/ze_logtype" and not [t].empty? user_mapping = true logbasename = [t] end if t == "zebrium.com/ze_service_group" and not [t].empty? override_deployment = [t] end end end unless kubernetes["labels"].nil? for k in kubernetes["labels"].keys if k == "zebrium.com/ze_logtype" and not kubernetes["labels"][k].empty? user_mapping = true logbasename = kubernetes["labels"][k] end if k == "zebrium.com/ze_service_group" and not kubernetes["labels"][k].empty? override_deployment = kubernetes["labels"][k] end end end if not user_mapping logbasename = kubernetes["container_name"] end elsif chunk_tag =~ /^containers\./ if record.key?("tailed_path") fpath = record["tailed_path"] fname = File.basename(fpath) ary = fname.split('-') container_id = "" if ary.length == 2 container_id = ary[0] cm = (container_id) if cm.nil? return false, headers, nil end cfgs["container_id"] = container_id cfgs["container_name"] = cm['name'] labels = cm['labels'] for k in labels.keys do cfgs[k] = labels[k] if k == "zebrium.com/ze_logtype" and not labels[k].empty? user_mapping = true logbasename = labels[k] end if k == "zebrium.com/ze_service_group" and not labels[k].empty? override_deployment = labels[k] end end if not user_mapping logbasename = cm['name'] end ids["app"] = logbasename cfgs["image"] = cm['image'] else log.error("Wrong container log file: ", fpath) end else log.error("Missing tailed_path on logs with containers.* tag") end elsif has_container_keys logbasename = record['container_name'].sub(/^\//, '') ids["app"] = logbasename cfgs["container_id"] = record['container_id'] cfgs["container_name"] = logbasename else is_container_log = false if record.key?("tailed_path") fpath = record["tailed_path"] fbname = File.basename(fpath, ".*") if @file_mappings.key?(fpath) logbasename = @file_mappings[fpath] user_mapping = true ids["ze_logname"] = fbname else logbasename = fbname.split('.')[0] if logbasename != fbname ids["ze_logname"] = fbname end end elsif record.key?("_SYSTEMD_UNIT") logbasename = record["_SYSTEMD_UNIT"].gsub(/\.service$/, '') elsif chunk_tag =~ /^k8s\.events/ logbasename = "zk8s-events" # Allow Cluster name to be set via an env variable if !@cluster_name.nil? and !@cluster_name.empty? cfgs["cluster_name"] = @cluster_name end elsif chunk_tag =~ /^ztcp\.events\./ ids["host"] = record_host.empty? ? "ztcp_host": record["host"] logbasename = record["logbasename"] ? record["logbasename"] : "ztcp_stream" forwarded_log = true log_type = "tcp_forward" elsif chunk_tag =~ /^zhttp\.events\./ ids["host"] = record_host.empty? ? "ztttp_host" : record["host"] logbasename = record["logbasename"] ? record["logbasename"] : "zhttp_stream" forwarded_log = true log_type = "http_forward" else # Default goes to zlog-collector. Usually there are fluentd generated message # and our own log messages # for these generic messages, we will send as json messages return true, {}, nil end ids["app"] = logbasename end cfgs["ze_file_path"] = fpath if not ids.key?("host") or ids.fetch("host").nil? if record_host.empty? ids["host"] = get_host() else ids["host"] = record_host end end unless @ze_deployment_name.empty? ids["ze_deployment_name"] = @ze_deployment_name end unless override_deployment_from_ns_svcgrp_map.empty? log.debug("Updating ze_deployment_name ns_svcgrp_map '#{override_deployment_from_ns_svcgrp_map}'") ids["ze_deployment_name"] = override_deployment_from_ns_svcgrp_map end unless override_deployment.empty? log.debug("Updating ze_deployment_name to '#{override_deployment}'") ids["ze_deployment_name"] = override_deployment end for k in @ze_tags.keys do [k] = @ze_tags[k] end ["fluentd_tag"] = chunk_tag id_key = "" keys = ids.keys.sort keys.each do |k| if ids.key?(k) if id_key.empty? id_key = k + "=" + ids[k] else id_key = id_key + "," + k + "=" + ids[k] end end end if record.key?("tailed_path") map_path_ids(record["tailed_path"], ids, cfgs, ) add_kubernetes_cfgs_for_pod_id(cfgs) end # host should be handled as a config element instead of an id. # This is used when host changes frequently, causing issues with # detection. The actual host is stored in the cfgs metadata, and # a constant is stored in the ids metadata. # Note that a host entry must be present in ids for correct backend # processing, it is simply a constant at this point. if ze_handle_host_as_config && ids.key?("host") cfgs["host"] = ids["host"] ids["host"] = "host_in_config" end has_stream_token = false if @stream_tokens.key?(id_key) # Make sure there is no meta data change. If there is change, new stream token # must be requested. = true if (cfgs.length == @stream_tokens[id_key]['cfgs'].length && .length == @stream_tokens[id_key]['tags'].length) @stream_tokens[id_key]['cfgs'].keys.each do |k| old_cfg = @stream_tokens[id_key]['cfgs'][k] if old_cfg != cfgs[k] log.info("Stream " + id_key + " config has changed: old " + old_cfg + ", new " + cfgs[k]) = false break end end @stream_tokens[id_key]['tags'].keys.each do |k| old_tag = @stream_tokens[id_key]['tags'][k] if old_tag != [k] log.info("Stream " + id_key + " config has changed: old " + old_tag + ", new " + [k]) = false break end end else log.info("Stream " + id_key + " number of config or tag has changed") = false end if has_stream_token = true end end if has_stream_token stream_token = @stream_tokens[id_key]["token"] else log.info("Request new stream token with key " + id_key) stream_token = get_stream_token(ids, cfgs, , logbasename, is_container_log, user_mapping, log_type, forwarded_log) @stream_tokens[id_key] = { "token" => stream_token, "cfgs" => cfgs, "tags" => } end # User can use node label on pod to override "host" meta data from kubernetes headers["authtoken"] = stream_token headers["Content-Type"] = "application/json" headers["Transfer-Encoding"] = "chunked" return true, headers, stream_token end |
#get_stream_token(ids, cfgs, tags, logbasename, is_container_log, user_mapping, log_type, forwarded_log) ⇒ Object
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 842 def get_stream_token(ids, cfgs, , logbasename, is_container_log, user_mapping, log_type, forwarded_log) = {} ['stream'] = "native" ['logbasename'] = logbasename ['user_logbasename'] = user_mapping ['container_log'] = is_container_log ['log_type'] = log_type ['forwarded_log'] = forwarded_log ['ids'] = ids ['cfgs'] = cfgs ['tags'] = ['tz'] = @ze_timezone.empty? ? Time.now.zone : @ze_timezone ['ze_log_collector_vers'] = $ZLOG_COLLECTOR_VERSION + "-" + @ze_log_collector_type headers = {} headers["authtoken"] = @auth_token.to_s headers["Content-Type"] = "application/json" headers["Transfer-Encoding"] = "chunked" @stream_token_req_sent = @stream_token_req_sent + 1 resp = post_data(@zapi_token_uri, .to_json, headers) if resp.ok? == false if resp.code == 401 raise RuntimeError, "Invalid auth token: #{resp.code} - #{resp.body}" else raise RuntimeError, "Failed to send data to HTTP Source. #{resp.code} - #{resp.body}" end else @stream_token_req_success = @stream_token_req_success + 1 end parse_resp = JSON.parse(resp.body) if parse_resp.key?("token") return parse_resp["token"] else raise RuntimeError, "Failed to get stream token from zapi. #{resp.code} - #{resp.body}" end end |
#map_path_ids(tailed_path, ids, cfgs, tags) ⇒ Object
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 364 def map_path_ids(tailed_path, ids, cfgs, ) if not @path_mappings.active return end @path_mappings.patterns.each { |re| res = re.match(tailed_path) if res captures = res.named_captures captures.each { |key, value| if @path_mappings.ids[key] != nil ids[key] = value end if @path_mappings.cfgs[key] != nil cfgs[key] = value end if @path_mappings.[key] != nil [key] = value end } end } end |
#multi_workers_ready? ⇒ Boolean
137 138 139 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 137 def multi_workers_ready? false end |
#post_data(uri, data, headers) ⇒ Object
880 881 882 883 884 885 886 887 888 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 880 def post_data(uri, data, headers) log.trace("post_data to " + uri.to_s + ": headers: " + headers.to_s) myio = StringIO.new(data) class <<myio undef :size end resp = @http.post(uri, myio, headers) resp end |
#post_message_data(send_json, headers, messages) ⇒ Object
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 967 def (send_json, headers, ) @data_post_sent = @data_post_sent + 1 if send_json req = {} req['log_type'] = 'generic' req['messages'] = headers = {} headers["authtoken"] = @auth_token headers["Content-Type"] = "application/json" resp = post_data(@zapi_ingest_uri, req.to_json, headers) if resp.ok? == false log.error("Server ingest API return error: code #{resp.code} - #{resp.body}") else @data_post_success = @data_post_success + 1 end else resp = post_data(@zapi_post_uri, .join("\n") + "\n", headers) if resp.ok? == false if resp.code == 401 # Our stream token becomes invalid for some reason, have to acquire new one. # Usually this only happens in testing when server gets recreated. # There is no harm to clear all stream tokens. log.error("Server says stream token is invalid: #{resp.code} - #{resp.body}") log.error("Delete all stream tokens") @stream_tokens = {} raise RuntimeError, "Delete stream token, and retry" else raise RuntimeError, "Failed to send data to HTTP Source. #{resp.code} - #{resp.body}" end else @data_post_success = @data_post_success + 1 end end end |
#prefer_buffered_processing ⇒ Object
141 142 143 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 141 def prefer_buffered_processing @use_buffer end |
#prepare_support_data ⇒ Object
956 957 958 959 960 961 962 963 964 965 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 956 def prepare_support_data() data = {} data['stream_token_req_sent'] = @stream_token_req_sent data['stream_token_req_success'] = @stream_token_req_success data['data_post_sent'] = @data_post_sent data['data_post_success'] = @data_post_success data['support_post_sent'] = @support_post_sent data['support_post_success'] = @support_post_success return data end |
#process(tag, es) ⇒ Object
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 938 def process(tag, es) es = inject_values_to_event_stream(tag, es) es.each {|time,record| if record.key?("kubernetes") and not record.fetch("kubernetes").nil? str = "" kubernetes = record["kubernetes"].clone container_name = kubernetes["container_name"] str = str + "container_name=" + container_name + "," host = kubernetes["host"] str = str + "host=" + host + "," kubernetes["labels"].each do |k, v| str = str + "label:" + k + "=" + v + "," end str = str + "\n" end } end |
#read_file_mappings ⇒ Object
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 332 def read_file_mappings() file_map_cfg_file = "/etc/td-agent/log-file-map.conf" if not File.exist?(file_map_cfg_file) log.info(file_map_cfg_file + " does not exist") old_file_map_cfg_file = "/etc/zebrium/log-file-map.cfg" if not File.exist?(old_file_map_cfg_file) log.info(old_file_map_cfg_file + " does not exist") return end log.warn(old_file_map_cfg_file + " is obsolete, please move it to " + file_map_cfg_file) file_map_cfg_file = old_file_map_cfg_file end log.info(file_map_cfg_file + " exists") file = File.read(file_map_cfg_file) file_mappings = JSON.parse(file) file_mappings['mappings'].each { |item| if item.key?('file') and item['file'].length > 0 and item.key?('alias') and item['alias'].length > 0 if item['file'].index(',') log.warn(item['file'] + " in " + file_map_cfg_file + " has comma, alias mapping must be one-to-one mapping ") next end if item['file'].index('*') log.warn(item['file'] + " in " + file_map_cfg_file + " has *, alias mapping must be one-to-one mapping ") next end log.info("Adding mapping " + item['file'] + " => " + item['alias']) @file_mappings[item['file']] = item['alias'] end } end |
#read_ns_to_svcgrp_mappings ⇒ Object
def format(tag, time, record)
record = inject_values_to_record(tag, time, record)
@formatter.format(tag, time, record).chomp + "\n"
end
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 233 def read_ns_to_svcgrp_mappings() if ze_ns_svcgrp_map_file.length() == 0 @ns_to_svcgrp_mappings.active = false return end ns_svcgrp_map_file = @ze_ns_svcgrp_map_file if not File.exist?(ns_svcgrp_map_file) log.info(ns_svcgrp_map_file + " ns_svcgrp_map_file does not exist.") @ns_to_svcgrp_mappings.active = false return end @ns_to_svcgrp_mappings.active = true nsj = "" log.info(ns_svcgrp_map_file + " exists, loading namespace to svcgrp maps") file = File.read(ns_svcgrp_map_file) begin nsj = JSON.parse(file) rescue Exception => e log.error(ns_svcgrp_map_file + " does not appear to contain valid JSON: " + e.) @ns_to_svcgrp_mappings.active = false return end log.info(nsj) nsj.each { |key, value| if( value != "" ) @ns_to_svcgrp_mappings.svcgrps.store(key, value) end } if @ns_to_svcgrp_mappings.svcgrps.length() == 0 log.error("No ns/svcgrp mappings are defined in "+ns_svcgrp_map_file) @ns_to_svcgrp_mappings.active = false end end |
#read_path_mappings ⇒ Object
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 267 def read_path_mappings() if ze_path_map_file.length() == 0 return end path_map_cfg_file = @ze_path_map_file if not File.exist?(path_map_cfg_file) log.info(path_map_cfg_file + " does not exist.") @path_mappings.active = false return end @path_mappings.active = true pmj = "" log.info(path_map_cfg_file + " exists, loading path maps") file = File.read(path_map_cfg_file) begin pmj = JSON.parse(file) rescue log.error(path_map_cfg_file+" does not appear to contain valid JSON") @path_mappings.active = false return end log.info(pmj) pmj['mappings'].each { |key, value| if key == 'patterns' # patterns value.each { |pattern| begin re = Regexp.compile(pattern, Regexp::EXTENDED) @path_mappings.patterns.append(re) rescue log.error("Invalid path pattern '" + pattern + "' detected") end } elsif key == 'ids' # ids value.each { |id| @path_mappings.ids.store(id, id) } elsif key == 'configs' # configs value.each { |config| @path_mappings.cfgs.store(config, config) } elsif key == 'tags' # tags value.each { |tag| log.info(@path_mappings.) @path_mappings..store(tag, tag) } else log.error("Invalid JSON key '"+key+"' detected") end } if @path_mappings.patterns.length() == 0 log.info("No patterns are defined in "+path_map_cfg_file) @path_mappings.active = false elsif @path_mappings.ids.length() == 0 and @path_mappings.cfgs.length() == 0 and @path_mappings..length() == 0 log.error("No ids/configs/tag mappings are defined in "+path_map_cfg_file) @path_mappings.active = false end end |
#save_kubernetes_cfgs(cfgs) ⇒ Object
save kubernetes configues, related to a specifc pod_id for potential use later for container file-based logs
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 457 def save_kubernetes_cfgs(cfgs) if (not cfgs.key?("pod_id")) or cfgs.fetch("pod_id").nil? return end pod_id = cfgs["pod_id"] if @pod_configs.cfgs.key?(pod_id) pod_cfg = @pod_configs.cfgs[pod_id] else pod_cfg = PodConfig.new() end pod_cfg.atime = Time.now() # Select which config keys to save. keys = [ "cmdb_name", "namespace_name", "namespace_id", "container_name", "pod_name" ] for k in keys do if cfgs.key?(k) and not cfgs.fetch(k).nil? pod_cfg.cfgs[k] = cfgs[k] end end @pod_configs.cfgs[pod_id]=pod_cfg end |
#send_support_data(data) ⇒ Object
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 1113 def send_support_data(data) = {} ['collector_vers'] = $ZLOG_COLLECTOR_VERSION ['host'] = @etc_hostname ['data'] = data headers = {} headers["Authorization"] = "Token " + @auth_token.to_s headers["Content-Type"] = "application/json" headers["Transfer-Encoding"] = "chunked" @support_post_sent = @support_post_sent + 1 resp = post_data(@zapi_support_uri, .to_json, headers) if resp.ok? == false log.error("Failed to send data to HTTP Source. #{resp.code} - #{resp.body}") else @support_post_success = @support_post_success + 1 end end |
#shutdown ⇒ Object
This method is called when shutting down.
1138 1139 1140 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 1138 def shutdown super end |
#start ⇒ Object
This method is called when starting.
1133 1134 1135 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 1133 def start super end |
#write(chunk) ⇒ Object
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 |
# File 'lib/fluent/plugin/out_zebrium.rb', line 1002 def write(chunk) epoch = Time.now.to_i if epoch - @last_support_data_sent > @ze_support_data_send_intvl data = prepare_support_data() send_support_data(data) @last_support_data_sent = epoch end tag = chunk..tag = {} log.trace("out_zebrium: write() called tag=", tag) headers = {} = [] num_records = 0 send_json = false host = '' = {} last_stoken = {} last_headers = {} chunk.each do |entry| record = entry[1] if @ze_send_json == false if entry[1].nil? log.warn("nil detected, ignoring remainder of chunk") return end should_send, headers, cur_stoken = get_request_headers(tag, record) if should_send == false return end end # get_request_headers() returns empty header, it means # we should send json message to server if headers.empty? or @ze_send_json send_json = true if host.empty? if record.key?("host") and not record["host"].empty? host = record["host"] else host = get_host() end ['collector'] = $ZLOG_COLLECTOR_VERSION ['host'] = host ['ze_deployment_name'] = @ze_deployment_name ['tags'] = @ze_tags.dup ['tags']['fluentd_tag'] = tag end end if num_records == 0 last_stoken = cur_stoken last_headers = headers elsif last_stoken != cur_stoken log.info("Streamtoken changed in chunk, num_records="+num_records.to_s) (send_json, last_headers, ) = [] last_stoken = cur_stoken last_headers = headers num_records = 0 end if entry[0].nil? epoch_ms = (Time.now.strftime('%s.%3N').to_f * 1000).to_i else epoch_ms = (entry[0].to_f * 1000).to_i end if send_json m = {} m['meta'] = m['line'] = record m['line']['timestamp'] = epoch_ms begin json_str = m.to_json rescue Encoding::UndefinedConversionError json_str = m.to_s.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?') end .push(json_str) else msg_key = nil if not tag =~ /^k8s\.events/ # journald use key "MESSAGE" for log message for k in ["log", "message", "LOG", "MESSAGE" ] if record.key?(k) and not record.fetch(k).nil? msg_key = k break end end if msg_key.nil? next end end if tag =~ /^k8s\.events/ and record.key?('object') and record['object']['kind'] == "Event" line = "ze_tm=" + epoch_ms.to_s + ",msg=" + get_k8s_event_str(record) else line = "ze_tm=" + epoch_ms.to_s + ",msg=" + record[msg_key].chomp end .push(line) end num_records += 1 end # Post remaining messages, if any if num_records == 0 log.trace("Chunk has no record, no data to post") return end (send_json, headers, ) end |