| id | title | description |
|---|---|---|
word-list |
Word List |
An alphabetized list of commonly used terms at Sumo Logic, including components and features of Sumo Logic, and other usage issues, such as punctuation and capitalization. |
:::caution
🚧 Under construction 🚧 :::
This word list provides an alphabetized list of commonly used terms at Sumo Logic, including components and features of Sumo Logic, and other usage issues, such as punctuation and capitalization. This is not a glossary. Here is the Glossary.
Acronyms. An acronym uses the first initials of a word or phrase, for brevity. Our industry is full of them, and they can get confusing if their usage isn't clear. Acronyms should be capitalized, if not used directly in a query, etc. Unless the usage is clear from the context, for the first usage, spell out the phrase, then present the acronym in parenthesis. For example: Secure Shell (SSH).
Aggregates tab. When referring to the Aggregates tab (where aggregate search results are displayed) the term Aggregates is capitalized.
Ampersand (&). Don't use for "and". Spell out.
Anomaly Detection. Always capitalize.
Apps. When referring to a Sumo Logic App, capitalize. Otherwise, capitalization is not necessary. No need to spell out application.
Autocomplete. One word, not two. The Sumo Logic feature is called Search Autocomplete.
Check box. Check box is two words. Don't use checkbox.
Classic UI. Use this term to distinguish the old UI.
Click. You click a UI element. Do not use "click on".
Collector. When referring to a Collector or Collectors, the term is capitalized. When referring to "collecting events" or "data collection", the terms are not capitalized.
Color palette. Use the official Sumo color palette when creating diagrams.
Column. When referring to a column in a Dashboard, the term is not capitalized unless it's the only word in a line of UI (for example, in the Add to Dashboard dialog box "Column" is capitalized). The word "column" doesn't appear in the main Dashboard UI.
Dashboard. When referring to a user-created dashboard, do not capitalize.
Dashboard Theme. Choose between light or dark themes for Dashboards. Only capitalize Theme when you're referring to the UI element in the Dashboard Properties menu.
Data. Data is plural. Use "data are", not "data is".
Dimension. Used interchangeably with tags.
Drill down. Drill down, as in a menu, or other filtering feature is two words, not one.
E.g., i.e., and etc., These abbreviations are parenthetical, which means they take a comma after.
Email. Email is one word, lowercase. Do not use a hyphen, such as "e-mail". Do not capitalize if it is not at the beginning of a sentence.
Em dash. We don't use this often, but if you need to use it, insert the em dash symbol (—), don't use a double hyphen (–).
Exclamation points ! . Use exclamation points only in warnings and greetings. Let your text convey the enthusiasm or importance of the statement. Don't make the reader wait until the exclamation point to find out the text is significant.
GB and Gbit. GB is the acronym for gigabytes. Gbit or Gb is the acronym for gigabits. Make sure to capitalize correctly. Don't use a space between the acronym and the number. (Example: 10GB or 15Gbit.)
**Geolocation. **Geolocation is one word. It is not capitalized unless used at the beginning of a sentence.
Geo lookup operator. geo lookup is two words.
Hash rules. Hash rules replace a message with a unique, randomly-generated code to protect sensitive or proprietary information. You may want to hash unique identifiers, such as credit card numbers or user names. By hashing this type of data, you can still track it, even though it's fully hidden.
Hibachi. Project for content sharing and collaboration. Includes a new app catalog and app installation flow and a new library design.
Home Page. Persistent tab, which services the Jiro and Hibachi projects by helping users get started and discover content more easily.
Hosted Collectors. Hosted Collectors don't require installation or activation, nor do they have physical requirements, since they're hosted in HTTP Source, an endpoint for receiving a file (or a batch of files) uploaded via a unique URL generated for the Source. The URL securely encodes the Collector and Source information. You can add as many HTTP Sources as you'd like to a single Hosted Collector.
If operator. A ternary operator used to evaluate a condition as either true or false, with values assigned for each outcome. It is a shorthand way to express an if-else condition.
Include rule. Include rules are used to send only the data you'd like in your Sumo Logic account (a "whitelist" filter). This type of filter can be very useful when the list of log data you want to send to Sumo Logic is easier to filter than setting up exclude filters for all of the types of messages you'd like to exclude.
**Installed Collector. **Installed Collectors are deployed in your environment, either on a local machine, a machine in your organization, or even an Amazon Machine Image (AMI). Installed Collectors require a software download and installation. Upgrades to Collector software are released regularly by Sumo Logic.
JavaScript. Always use camelCase.
Library. The Sumo Logic Library (formerly the Content Library) is now just the Library. Capitalize.
Login vs Log In. Login as one word is a noun or an adjective. Log in as two words is a verb. For example, "You can log in on the login page."
Markdown. Used in Text Panels. Capitalize Markdown.
**MB and Mbit. **MB is the acronym for megabytes. Mbit or Mb is the acronym for megabits. Make sure to capitalize correctly. Don't use a space between the acronym and the number. (Example: 10MB or 15Mbit.)
Menu. When referring to a menu in the UI, use the word menu alone. Don't use drop-down menu, list, or selector.
Messages tab. When referring to the Messages tab (where non-aggregate search results are displayed) the term Messages is capitalized.
Multiline. Should be one word, not two, or hyphenated.
Numbers. Spell numbers out up to nine, then use numerals. (Example: There are nine Collectors and 10 Sources.)
Operators. When referring to a search operator, capitalize the operator's name only if it begins a sentence.
Page. When referring to a page in the UI, such as the Search page, use page. Don't use pane or tab. A tab appears inside a page. (Example: The Messages tab appears on the Search page.)
Please. Avoid using please. You're making recommendations on how to use software and services; it's not an inconvenience to the user.
Plugin. Plugin is one word, not two, and no hyphen.
Quotation marks (" " or ' '). Do not use in error or warning messages, or in UI text unless necessary to avoid confusion with situations where " " or ' ' are required.
Real Time. As in Real Time alerts. Use two words, no hyphen. Should always be capitalized when referring to Real Time alerts, as that is a feature name. Not capitalized for a general use, as in "real time analysis".
Repo. Short for repository. No need to spell out repository as our audience is technical enough for this to be clear.
Saved search. Saved search is not capitalized.
**Scheduled search. **Scheduled search is not capitalized.
Search. Search is not capitalized, unless you are referring to the Search page.
Search Autocomplete. One word, not two. The Sumo Logic feature is called Search Autocomplete.
Setup vs Set up. Setup as one word is a noun or an adjective. Set up as two words is a verb. For example, "You can set up your Collector using the setup procedure."
Source. When referring to a Sumo Logic Source, the term is capitalized.
Sources. When referring to more than one Source, the term Sources is capitalized. The following Sources are available and should be capitalized as shown below:
- Local File Source
- Remote File Source
- Syslog Source
- Local Windows Event Log Source
- Remote Windows Event Log Source
- Script Source
- Script Action
Hosted Collectors can use:
- Amazon S3 Source
- HTTP Source
Space bar. Two words, not one.
Tabs. When referring to tabs in Sumo Logic, be sure to capitalize each tab's name, but not tab. (Examples: Welcome tab, Search tab, Status tab, Collectors, Users, Account).
Text box. Use text box, not field. A field is a special part of a query.
Text Panel. Used in dashboards, capitalize Panel. See also Markdown.
Third Party. Hyphenate as an adjective, not as a noun. For example, "We use third-party scripts" is hyphenated. But "Scripts are written by a third party" is not hyphenated.
Timeline. Timeline is one word, not two.
Time range. Time range is two words, not one.
**Time series. **Time series is two words, not one.
Time slice. Time slice is two words, not one.
Timestamp. Timestamp is one word.
Time zone. Time zone is two words, not one.
Web Application. Avoid using where possible. "Sumo" or "our product" should be sufficient. If you need to refer to our web application to distinguish from API, do so. Don't capitalize.
Website. Website or websites is one word.
Where operator. A conditional operator that can precede or follow another operator. Example combinations include where x matches y, where x in (a, b, c), where x not in (a, b, c) and where a > 1 and b / 4 < sqrt(x).
Wildcard. Wildcard is one word.