summaryrefslogtreecommitdiff
path: root/lib/gitlab/highlight.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/gitlab/highlight.rb')
-rw-r--r--lib/gitlab/highlight.rb35
1 files changed, 32 insertions, 3 deletions
diff --git a/lib/gitlab/highlight.rb b/lib/gitlab/highlight.rb
index 765d3dfca56..e4857280969 100644
--- a/lib/gitlab/highlight.rb
+++ b/lib/gitlab/highlight.rb
@@ -4,13 +4,20 @@ module Gitlab
class Highlight
TIMEOUT_BACKGROUND = 30.seconds
TIMEOUT_FOREGROUND = 1.5.seconds
- MAXIMUM_TEXT_HIGHLIGHT_SIZE = 512.kilobytes
def self.highlight(blob_name, blob_content, language: nil, plain: false)
new(blob_name, blob_content, language: language)
.highlight(blob_content, continue: false, plain: plain)
end
+ def self.too_large?(size)
+ return false unless size.to_i > Gitlab.config.extra['maximum_text_highlight_size_kilobytes']
+
+ over_highlight_size_limit.increment(source: "text highlighter") if Feature.enabled?(:track_file_size_over_highlight_limit)
+
+ true
+ end
+
attr_reader :blob_name
def initialize(blob_name, blob_content, language: nil)
@@ -23,7 +30,7 @@ module Gitlab
def highlight(text, continue: false, plain: false, context: {})
@context = context
- plain ||= text.length > MAXIMUM_TEXT_HIGHLIGHT_SIZE
+ plain ||= self.class.too_large?(text.length)
highlighted_text = highlight_text(text, continue: continue, plain: plain)
highlighted_text = link_dependencies(text, highlighted_text) if blob_name
@@ -65,9 +72,11 @@ module Gitlab
tokens = lexer.lex(text, continue: continue)
Timeout.timeout(timeout_time) { @formatter.format(tokens, context.merge(tag: tag)).html_safe }
rescue Timeout::Error => e
+ add_highlight_timeout_metric
+
Gitlab::ErrorTracking.track_and_raise_for_dev_exception(e)
highlight_plain(text)
- rescue
+ rescue StandardError
highlight_plain(text)
end
@@ -78,5 +87,25 @@ module Gitlab
def link_dependencies(text, highlighted_text)
Gitlab::DependencyLinker.link(blob_name, text, highlighted_text)
end
+
+ def add_highlight_timeout_metric
+ return unless Feature.enabled?(:track_highlight_timeouts)
+
+ highlight_timeout.increment(source: Gitlab::Runtime.sidekiq? ? "background" : "foreground")
+ end
+
+ def highlight_timeout
+ @highlight_timeout ||= Gitlab::Metrics.counter(
+ :highlight_timeout,
+ 'Counts the times highlights have timed out'
+ )
+ end
+
+ def self.over_highlight_size_limit
+ @over_highlight_size_limit ||= Gitlab::Metrics.counter(
+ :over_highlight_size_limit,
+ 'Count the times files have been over the highlight size limit'
+ )
+ end
end
end