Class: Fluent::Plugin::AzureStorageAppendBlobOut

Inherits:
Output
  • Object
show all
Defined in:
lib/fluent/plugin/out_azure-storage-append-blob.rb

Constant Summary collapse

DEFAULT_FORMAT_TYPE = 
'out_file'.freeze
AZURE_BLOCK_SIZE_LIMIT = 
4 * 1024 * 1024 - 1

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AzureStorageAppendBlobOut

Returns a new instance of AzureStorageAppendBlobOut.



22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/fluent/plugin/out_azure-storage-append-blob.rb', line 22

def initialize
  super
  @use_msi = false

  # Storage endpoint suffixes for various environments, see https://github.com/Azure/go-autorest/blob/master/autorest/azure/environments.go
  @storage_endpoint_mapping = {
    'AZURECHINACLOUD' => 'core.chinacloudapi.cn',
    'AZUREGERMANCLOUD' => 'core.cloudapi.de',
    'AZUREPUBLICCLOUD' => 'core.windows.net',
    'AZUREUSGOVERNMENTCLOUD' => 'core.usgovcloudapi.net'
  }
end

Instance Attribute Details

#bs ⇒ Object (readonly)

Returns the value of attribute bs.



61
62
63
 
# File 'lib/fluent/plugin/out_azure-storage-append-blob.rb', line 61

def bs
  @bs
end

Instance Method Details

#configure(conf) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/fluent/plugin/out_azure-storage-append-blob.rb', line 63

def configure(conf)
  super

  @formatter = formatter_create

  @path_slicer = if @localtime
                   proc do |path|
                     Time.now.strftime(path)
                   end
                 else
                   proc do |path|
                     Time.now.utc.strftime(path)
                   end
                 end

  @azure_storage_dns_suffix = @storage_endpoint_mapping[@azure_cloud]
  if @azure_storage_dns_suffix.nil?
    raise ConfigError 'azure_cloud invalid, must be either of AZURECHINACLOUD, AZUREGERMANCLOUD, AZUREPUBLICCLOUD, AZUREUSGOVERNMENTCLOUD'
  end

  if (@azure_storage_access_key.nil? || @azure_storage_access_key.empty?) &&
     (@azure_storage_sas_token.nil? || @azure_storage_sas_token.empty?) &&
     (@azure_storage_connection_string.nil? || @azure_storage_connection_string.empty?)
    log.info 'Using MSI since neither of azure_storage_access_key, azure_storage_sas_token, azure_storage_connection_string was provided.'
    @use_msi = true
  elsif @azure_storage_connection_string.nil? || @azure_storage_connection_string.empty?
    raise ConfigError, 'azure_storage_account needs to be specified' if .nil?
    raise ConfigError, 'azure_container needs to be specified' if @azure_container.nil?
  end

  @blob_options = {}

  if !@calculate_checksums
    @blob_options[:content_md5] = ''
  end
end

#container_exists?(container) ⇒ Boolean

Returns:

  • (Boolean) 


192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/fluent/plugin/out_azure-storage-append-blob.rb', line 192

def container_exists?(container)
  begin
    @bs.get_container_properties(container)
  rescue Azure::Core::Http::HTTPError => e
    if e.status_code == 404 # container does not exist
      return false
    else
      raise
    end
  end
  true
end

#format(tag, time, record) ⇒ Object 



162
163
164
165
 
# File 'lib/fluent/plugin/out_azure-storage-append-blob.rb', line 162

def format(tag, time, record)
  r = inject_values_to_record(tag, time, record)
  @formatter.format(tag, time, r)
end

#get_access_token ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/fluent/plugin/out_azure-storage-append-blob.rb', line 104

def get_access_token
  access_key_request = Faraday.new('http://169.254.169.254/metadata/identity/oauth2/token?' \
                                   "api-version=#{@azure_imds_api_version}" \
                                   '&resource=https://storage.azure.com/' \
                                   "#{!azure_msi_client_id.nil? ? "&client_id=#{azure_msi_client_id}" : ''}",
                                   headers: { 'Metadata' => 'true' }).get

  if access_key_request.status == 200
    JSON.parse(access_key_request.body)['access_token']
  else
    raise 'Access token request was not sucssessful. Possibly due to missing azure_msi_client_id config parameter.'
  end
end

#multi_workers_ready? ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/fluent/plugin/out_azure-storage-append-blob.rb', line 100

def multi_workers_ready?
  true
end

#start ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/fluent/plugin/out_azure-storage-append-blob.rb', line 118

def start
  super
  if @use_msi
    token_credential = Azure::Storage::Common::Core::TokenCredential.new get_access_token
    token_signer = Azure::Storage::Common::Core::Auth::TokenSigner.new token_credential
    @bs = Azure::Storage::Blob::BlobService.new(
      storage_account_name: ,
      storage_dns_suffix: @azure_storage_dns_suffix,
      signer: token_signer
    )

    refresh_interval = @azure_token_refresh_interval * 60
    cancelled = false
    renew_token = Thread.new do
      Thread.stop
      until cancelled
        sleep(refresh_interval)

        token_credential.renew_token get_access_token
      end
    end
    sleep 0.1 while renew_token.status != 'sleep'
    renew_token.run
  elsif !@azure_storage_connection_string.nil? && !@azure_storage_connection_string.empty?
    @bs = Azure::Storage::Blob::BlobService.create_from_connection_string(@azure_storage_connection_string)
  else
    @bs_params = { storage_account_name: , storage_dns_suffix: @azure_storage_dns_suffix }

    if !@azure_storage_access_key.nil? && !@azure_storage_access_key.empty?
      @bs_params.merge!({ storage_access_key: @azure_storage_access_key })
    elsif !@azure_storage_sas_token.nil? && !@azure_storage_sas_token.empty?
      @bs_params.merge!({ storage_sas_token: @azure_storage_sas_token })
    end

    @bs = Azure::Storage::Blob::BlobService.create(@bs_params)

  end

  ensure_container
  @azure_storage_path = ''
  @last_azure_storage_path = ''
  @current_index = 0
end

#write(chunk) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/fluent/plugin/out_azure-storage-append-blob.rb', line 167

def write(chunk)
  metadata = chunk.metadata
  tmp = Tempfile.new('azure-')
  begin
    chunk.write_to(tmp)

    generate_log_name(metadata, @current_index)
    if @last_azure_storage_path != @azure_storage_path
      @current_index = 0
      generate_log_name(metadata, @current_index)
    end

    content = File.open(tmp.path, 'rb', &:read)

    append_blob(content, metadata)
    @last_azure_storage_path = @azure_storage_path
  ensure
    begin
      tmp.close(true)
    rescue StandardError
      nil
    end
  end
end