Before you dig into reading this guide, have you tried asking OpsGPT what this log means? You’ll receive a customized analysis of your log.
Try OpsGPT now for step-by-step guidance and tailored insights into your OpenSearch operation.
Briefly, this error occurs when the ‘writtenByStr’ field in the OpenSearch document is either missing or contains invalid data. This field is crucial as it identifies the author of the document. To resolve this issue, ensure that the ‘writtenByStr’ field is present in your document and that it contains valid data. If the field is missing, add it. If it’s invalid, correct the data. Also, ensure that your document adheres to the OpenSearch specifications to prevent such errors.
For a complete solution to your to your search operation, try for free AutoOps for Elasticsearch & OpenSearch . With AutoOps and Opster’s proactive support, you don’t have to worry about your search operation – we take charge of it. Get improved performance & stability with less hardware.
This guide will help you check for common problems that cause the log ” missing or invalid written_by [” + writtenByStr + “] ” to appear. To understand the issues related to this log, read the explanation below about the following OpenSearch concepts: index, blobstore.
Quick links
Overview
In OpenSearch, an index (plural: indices) contains a schema and can have one or more shards and replicas. An OpenSearch index is divided into shards and each shard is an instance of a Lucene index.
Indices are used to store the documents in dedicated data structures corresponding to the data type of fields. For example, text fields are stored inside an inverted index whereas numeric and geo fields are stored inside BKD trees.
Examples
Create index
The following example is based on OpenSearch version 5.x onwards. An index with two shards, each having one replica will be created with the name test_index1
PUT /test_index1?pretty
{
"settings" : {
"number_of_shards" : 2,
"number_of_replicas" : 1
},
"mappings" : {
"properties" : {
"tags" : { "type" : "keyword" },
"updated_at" : { "type" : "date" }
}
}
}List indices
All the index names and their basic information can be retrieved using the following command:
GET _cat/indices?v
Index a document
Let’s add a document in the index with the command below:
PUT test_index1/_doc/1
{
"tags": [
"opster",
"OpenSearch"
],
"date": "01-01-2020"
}Query an index
GET test_index1/_search
{
"query": {
"match_all": {}
}
}Query multiple indices
It is possible to search multiple indices with a single request. If it is a raw HTTP request, index names should be sent in comma-separated format, as shown in the example below, and in the case of a query via a programming language client such as python or Java, index names are to be sent in a list format.
GET test_index1,test_index2/_search
Delete indices
DELETE test_index1
Common problems
- It is good practice to define the settings and mapping of an Index wherever possible because if this is not done, OpenSearch tries to automatically guess the data type of fields at the time of indexing. This automatic process may have disadvantages, such as mapping conflicts, duplicate data and incorrect data types being set in the index. If the fields are not known in advance, it’s better to use dynamic index templates.
- OpenSearch supports wildcard patterns in Index names, which sometimes aids with querying multiple indices, but can also be very destructive too. For example, It is possible to delete all the indices in a single command using the following commands:
DELETE /*
To disable this, you can add the following lines in the OpenSearch.yml:
action.destructive_requires_name: true
Log Context
Log “missing or invalid written_by [” + writtenByStr + “]” class name is BlobStoreIndexShardSnapshot.java. We extracted the following from OpenSearch source code for those seeking an in-depth context :
} else if (physicalName == null || Strings.validFileName(physicalName) == false) {
throw new OpenSearchParseException("missing or invalid physical file name [" + physicalName + "]");
} else if (length < 0) {
throw new OpenSearchParseException("missing or invalid file length");
} else if (writtenBy == null) {
throw new OpenSearchParseException("missing or invalid written_by [" + writtenByStr + "]");
} else if (checksum == null) {
throw new OpenSearchParseException("missing checksum for name [" + name + "]");
}
return new FileInfo(name; new StoreFileMetadata(physicalName; length; checksum; writtenBy; metaHash); partSize);
}
